You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-16Lines changed: 18 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
This repository holds source code and publishable website for [**`chkware`**](https://github.com/chkware/cli#readme). Please access using https://chkware.github.io.
4
4
5
-
## Installation
5
+
###Installation
6
6
7
7
Clone the repo:
8
8
@@ -17,31 +17,33 @@ Install dependencies:
17
17
npm install
18
18
```
19
19
20
-
## Local Development
20
+
###Local Development
21
21
22
22
```
23
23
$ npm start
24
24
```
25
25
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.
27
27
28
-
## Build
28
+
Most changes are reflected live reload without having to restart the server.
29
+
30
+
### Build
29
31
30
32
```
31
33
$ npm run build
32
34
```
33
35
34
36
This command generates static content into the `build` directory and can be served using any static contents hosting service.
35
37
36
-
## Guides
38
+
###Guides
37
39
38
40
Learn how to contribute to this website.
39
41
40
42
### Configs
41
43
42
44
All the configs can be found in `docusaurus.config.js`.
43
45
44
-
### Create a doc page
46
+
####Create a doc page
45
47
46
48
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.
47
49
@@ -55,7 +57,7 @@ root
55
57
56
58
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).
57
59
58
-
### Create a doc category
60
+
####Create a doc category
59
61
60
62
Creating a `example.md` in a sub folder will create a category in the sidebar.
61
63
@@ -74,41 +76,41 @@ To change the category name or other category meta data, an optional file `_cate
74
76
}
75
77
```
76
78
77
-
### Static Assets
79
+
####Static Assets
78
80
79
81
The Static Assets can be found in the `static` folder. More [here](https://docusaurus.io/docs/next/static-assets).
80
82
81
-
### Change theme color
83
+
####Change theme color
82
84
83
85
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.
84
86
85
-
### Change codeBlock theme
87
+
####Change codeBlock theme
86
88
87
89
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).
88
90
89
-
### Syntax highlighting
91
+
####Syntax highlighting
90
92
91
93
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).
92
94
93
-
### Change footer
95
+
####Change footer
94
96
95
97
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).
96
98
97
-
### Blog
99
+
####Blog
98
100
99
101
To set up blog, start by creating a `blog` directory. More [here](https://docusaurus.io/docs/next/blog).
100
102
101
-
### Admonitions
103
+
####Admonitions
102
104
103
105
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).
104
106
105
-
### Update Docusaurus version
107
+
####Update Docusaurus version
106
108
107
109
To update Docusaurus version, manually change the version number in `package.json` to the desired version. Then run `npm run install`.
108
110
109
111
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).
110
112
111
-
## Status
113
+
###Status
112
114
113
115
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.
0 commit comments