-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
33 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,7 @@ | |
# generated files | ||
public/sitemap.json | ||
public/docs.json | ||
/www.zip | ||
|
||
# code editor files | ||
.vscode/ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,33 @@ | ||
# Sliver Docs | ||
|
||
The source code for the Sliver documentation site. | ||
|
||
### Developers | ||
|
||
To run the documentation site locally first install the dependencies and then run the `dev` npm script: | ||
|
||
```bash | ||
npm install | ||
npm run dev | ||
``` | ||
|
||
**NOTE:** The markdown is compiled into a static JSON object at build time. This means if you edit a `.md` file you will need to restart the dev server to see your changes. | ||
|
||
### Offline Docs | ||
|
||
To run your own copy of the documentation first install the dependencies and then run the `offline` npm script: | ||
|
||
```bash | ||
npm install | ||
npm run offline | ||
``` | ||
|
||
This will produce a `www.zip` file that contains the static html and JavaScript for the documentation site. You can extract this archive and host it anywhere: | ||
|
||
```bash | ||
unzip -o www.zip | ||
cd out/ | ||
python -m http.server 8000 | ||
``` | ||
|
||
Then open your browser to `http://localhost:8000/` to view the documentation. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters