Sysl website https://sysl.io is built using Docusaurus 2.
sysl-website
├── blog // all the blogs
├── docs // all the docs
├── src
│ ├── css // common css
│ └── pages // landing page components and css
├── static // website assets
│ └── img
├── docusaurus.config.js // configuration
├── sidebars.js // sidebar management
├── package.json
├── README.md
└── yarn.lock
All the documentation files are under docs which are Markdown-formatted. Markdown is a syntax that enables you to write formatted content in a readable syntax. Also, you can do more than just parsing Markdown by using Docusaurus 2.
Regards to adding image, we are using useBaseUrl instead of Markdown image syntax.
- Create a new Markdown file in
docswith header - Add it to
sidebars.js
All the blog files are under blog which are Markdown-formatted. Following the instruction to contribute to Blog.
The homepage code of this website is in src/pages/index.js with configuration docusaurus.config.js. Following configuration docs to contribute to Homepage.
$ yarn install
$ yarn start
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
This project uses Prettier to format all files.
$ yarn format
A development version is deployed using Netlify. Deployment previews are enabled, so each PR has a unique deployment preview link which can be found in the Github Status Checks.
linkcheck GitHub Action is used as the Markdown broken link check linter.
Algolia DocSearch is used for website searching. The crawler is configured in docsearch-config and it's now running every 24h.