Skip to main content

Create a doc

In docStatic, you write your content as Markdown in files called “Topics”. Typically, you will create each topic yourself, although certain types of docs may have autogenerated topics.

Note

GraphQL and OpenAPI docs are autogenerated from a server or schema.

To create a topic:

  1. From the Topics collection, click Add File.
  2. Give the topic a Title.
  3. (Optional) If you want to use the topic in context-sensitive help, give it a Slug. This is a fixed path from /docs/.
  4. Give the topic a Description. This is displayed in the Doc Card List.
  5. (Optional) Add any required taxonomy Tags.
  6. (Optional) Set any Conditions.
  7. Make sure the Workflow status is set to Draft.
  8. Enter your content.
  9. Click Save.

Doc front matter​

At the start of every topic is a section of YAML contained between two sets of three hyphens (---). DocStatic uses this for things such as:

  • Conditional Text
  • Taxonomies (doc tags)
  • Workflows

For more information, refer to Create a doc in the Docusaurus documentation.

Related topics

  • Docs introduction – An introduction to docStatic docs.
  • Footnotes – Automatically numbered and back-linked footnotes.
  • Tabs – Using tabs in docStatic.
  • Creating pages – Creating pages in the CMS.
  • Related Topics – Automatically generate links to related content based on shared taxonomy tags.
  • Hosted CMS – Using docStatic with cloud-hosted or self-hosted TinaCMS.
  • Figures – Images with captions and lightbox zoom.