Docs Template
Basejump includes a basic documentation template to get you started. Out of the box, it supports writing blogs using markdown files in the repo. It wouldn't be too hard to hook up Strapi or some other CMS, however, if you so wish.
Writing documentation
To write your first article, you'll want to create a new markdown file located at /content/docs/[locale]/your-path-here.md. The locale is the language code for the article, so if you're writing an article in English,
you'd use en. By default, articles are not published, to publish them, you'll need to add Frontmatter that includes a publish
date.
Documentation Metadata & Frontmatter
Frontmatter is a Markdown concept that allows you to add metadata to a markdown file. Basejump articles support the following metadata:
---
title: "Your Documentation Title"
category: "Category 1"
published: 2022-01-01
description: "This is automatically generated Basejump documentation!"
socialDescription: "Check out this automatically generated Basejump article!"
socialImage: "/images/basejump-logo.png"
---
Articles are sorted according to their published date with the most recent at the top. Any article that does not
include a published date is not visible on the site.
Disabling documentation
If you don't want to leverage the built-in documentation functionality, you can disable it by simply removing the docs folder from /src/pages. You'll also want to remove any links in the ContentHeader and ContentFooter.