Skip to content

Commit e7f5ab0

Browse files
committed
docs: update readme
1 parent aa18c23 commit e7f5ab0

1 file changed

Lines changed: 18 additions & 16 deletions

File tree

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This repository holds source code and publishable website for [**`chkware`**](https://github.com/chkware/cli#readme). Please access using https://chkware.github.io.
44

5-
## Installation
5+
### Installation
66

77
Clone the repo:
88

@@ -17,31 +17,33 @@ Install dependencies:
1717
npm install
1818
```
1919

20-
## Local Development
20+
### Local Development
2121

2222
```
2323
$ npm start
2424
```
2525

26-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
26+
This command starts a local development server and opens up a browser window. You can also follow `http://localhost:3000/` URL in any browser.
2727

28-
## Build
28+
Most changes are reflected live reload without having to restart the server.
29+
30+
### Build
2931

3032
```
3133
$ npm run build
3234
```
3335

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

36-
## Guides
38+
### Guides
3739

3840
Learn how to contribute to this website.
3941

4042
### Configs
4143

4244
All the configs can be found in `docusaurus.config.js`.
4345

44-
### Create a doc page
46+
#### Create a doc page
4547

4648
Create a Markdown file, `example.md`, and place it under the `docs` directory. Any markdown file will render into the site without needing any extra configuration. It will be displayed alphabetically on the sidebar.
4749

@@ -55,7 +57,7 @@ root
5557

5658
Markdown documents can use the Markdown front matter metadata fields, enclosed by a line `---` on either side. At the top of the file, you can optionally specify attributes in the front matter, so that Docusaurus will pick them up correctly when generating the site. Accepted fields can be found [here](https://docusaurus.io/docs/next/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter).
5759

58-
### Create a doc category
60+
#### Create a doc category
5961

6062
Creating a `example.md` in a sub folder will create a category in the sidebar.
6163

@@ -74,41 +76,41 @@ To change the category name or other category meta data, an optional file `_cate
7476
}
7577
```
7678

77-
### Static Assets
79+
#### Static Assets
7880

7981
The Static Assets can be found in the `static` folder. More [here](https://docusaurus.io/docs/next/static-assets).
8082

81-
### Change theme color
83+
#### Change theme color
8284

8385
Generate the variables from [here](https://docusaurus.io/docs/next/styling-layout#styling-your-site-with-infima). Then replace the variables in `src/css/custom.css` with these new variables. Don't forget variables for dark mode.
8486

85-
### Change codeBlock theme
87+
#### Change codeBlock theme
8688

8789
Docusaurus uses [Prism React Renderer](https://github.com/FormidableLabs/prism-react-renderer) to highlight code blocks. All configuration are in the `prism` object of `docusaurus.config.js`. You can specify a custom theme from the [list of available themes](https://github.com/FormidableLabs/prism-react-renderer/tree/master/src/themes).
8890

89-
### Syntax highlighting
91+
#### Syntax highlighting
9092

9193
To add syntax highlighting for any of the other [Prism-supported languages](https://prismjs.com/#supported-languages), define it in an array of additional languages. More [here](https://docusaurus.io/docs/next/markdown-features/code-blocks#supported-languages).
9294

93-
### Change footer
95+
#### Change footer
9496

9597
You can add logo and a copyright to the footer via `themeConfig.footer`. More [here](https://docusaurus.io/docs/next/api/themes/configuration#footer-1).
9698

97-
### Blog
99+
#### Blog
98100

99101
To set up blog, start by creating a `blog` directory. More [here](https://docusaurus.io/docs/next/blog).
100102

101-
### Admonitions
103+
#### Admonitions
102104

103105
In addition to the basic Markdown syntax, Docusaurus use [remark-admonitions](https://github.com/elviswolcott/remark-admonitions) alongside MDX to add support for admonitions. Admonitions are wrapped by a set of 3 colons. More [here](https://docusaurus.io/docs/next/markdown-features/admonitions).
104106

105-
### Update Docusaurus version
107+
#### Update Docusaurus version
106108

107109
To update Docusaurus version, manually change the version number in `package.json` to the desired version. Then run `npm run install`.
108110

109111
Any required change/depricated message will be shown on the terminal when running the command `npm run start`. More [here](https://docusaurus.io/docs/next/installation#updating-your-docusaurus-version).
110112

111-
## Status
113+
### Status
112114

113115
The current status of the website is **under construction**. Please follow us on Twitter [@chkware](https://twitter.com/chkware) for update. Thank you for your patience.
114116

0 commit comments

Comments
 (0)