This is the source for Adminterface documentation site. It was scaffolded with and is currently built with Docusaurus. While some things are documented here, most of the Docusaurus user docs lives on their site.

• Getting started
• Editing existing docs
• Adding a new doc
• Docusaurus blog
• Algolia
• Converting logos

1. Install the dependencies:

   $ yarn install

2. Run the dev server

   $ yarn start

   This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

3. Build

   $ yarn build

   This command generates static content into the build directory and can be served using any static contents hosting service.

4. Deploy

   $ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

   This command is a convenient way to build the website and push to the gh-pages branch.

External docs live in the website/docs/ folder (make sure you're not adding docs to the top-level docs/ folder, which is for our internal docs).

For more information about docs, click here.

1. Create a new markdown doc:

   ❯ touch docs/my-new-doc.md

2. Initialize the doc with a header, and start writing!

   ---
   id: my-new-doc
   title: My New Doc
   ---
   
   My content...

   The filename is what will be used for your doc's URL. The id is what will be used to refer to your doc in the sidebar.

We are using Docusaurus' blog mechanism, which is basically a set of docs with release dates and which shows up in a separate section. For more information about blog posts, click here.

To create indexes on Algolia

1. Create an .env under the website directory

   # .env
   APPLICATION_ID=YOUR_APP_ID
   API_KEY=YOUR_API_KEY

2. run yarn crawl. You will need Docker and jq installed. See https://docsearch.algolia.com/docs/run-your-own for more info.

The logos are located in the static/img/ folder (i.e., at the top-level of the repo). Logos in the website's static/img/ folder are derived (usually: copied) from there.

If you make changes to the logo and want to re-generate the .ico file, install ImageMagick and then run:

$ convert static/img/logo.png -define icon:auto-resize static/img/favicon.ico