Sim-Docs is built using Docusaurus template.

How To Contribute

install node.js

Copy the repository of Sim-Docs using:

git clone https://github.com/xjp66666/sim-docs.git

or through SSH:

git clone git@github.com:xjp66666/sim-docs.git

under the root directory, install dependencies:

npm install

run live server locally:

npm run start

Markdown

Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. All the doc pages are placed under docs folder. The doc pages should be written in Markdown format. Click here to view basic syntax

Here is a minimal cheat sheet for you to look up when editing doc pages:

What is written	What it looks like
Text	Text
# Heading level 1	Heading level 1
## Heading level 2	Heading level 2
### Heading level 3	Heading level 3
#### Heading level 4	Heading level 4
_Italic_	Italic
**Bold**	Bold
[Text](https://xjp66666.github.io/sim-docs)	Text
`code`	code


For more styling and html stuff, check this.

CSS customization

To customize the CSS of this website, edit src/css/custom.css:

:root {
  --ifm-color-primary: #c8102e; // main brand color
  --ifm-color-primary-dark: #b40e29;
  --ifm-color-primary-darker: #a90d27;
  --ifm-color-primary-darkest: #8b0a20;
  --ifm-color-primary-light: #dc1233;
  --ifm-color-primary-lighter: #e01d3d;
  --ifm-color-primary-lightest: #e4485f;
  --ifm-code-font-size: 95%;
  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
}


[data-theme="dark"] {      //dark mode color
  --ifm-color-primary: #c8102e;
  --ifm-color-primary-dark: #ff3648;
  --ifm-color-primary-darker: #ff2a3d;
  --ifm-color-primary-darkest: #f5081d;
  --ifm-color-primary-light: #ff6474;
  --ifm-color-primary-lighter: #ff7080;
  --ifm-color-primary-lightest: #ff97a2;
  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
}

Home Page Customization

Edit js and css files under src to customize the homepage.