Docs intro

This is the internal Legion documentation and knowledge base.

Document management

To add a new page simply create a new markdown file under the docs folder in the appropriate subfolder.

Markdown is the main content authoring format. More info: docusaurus.io/docs/markdown-features

Page name is determined by:

• The first header in the doc (e.g. # Docs intro)
• If there is no header, the name of the file

Development

Built using

• Docusaurus - a modern static website generator.
• Mermaid for rendering diagrams
• docusaurus-search-local for simple document search capability (the index is created at build time)

Requirements

• Node.js version 18.0 or above:
  • When installing Node.js, you are recommended to check all checkboxes related to dependencies.

Run the site locally

1. Clone the repo:

   cd internal-docs
   git clone https://github.com/legion-security/internal-docs.git internal-docs

2. Start the docs site locally:

   npm install
   npm run start

   This will build the docs website locally and serve it through a development server, ready for you to view at http://localhost:3000/.

Hosting

The project is hosted on Cloudflare pages under the internal-docs project.