-
Notifications
You must be signed in to change notification settings - Fork 21
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
1 parent
4dcd8ff
commit dc44a07
Showing
2 changed files
with
72 additions
and
9 deletions.
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 |
---|---|---|
@@ -1,15 +1,41 @@ | ||
> Docs are a work in process. | ||
# Documentation | ||
|
||
1. Install the docs dependencies | ||
## About | ||
|
||
The documentation roughly attempts to follow [Diátaxis](https://diataxis.fr/). | ||
|
||
## View | ||
|
||
As of today, you can [view the moccasin documentation here.](https://cyfrin.github.io/moccasin/) | ||
|
||
## Build | ||
|
||
To build the documentation, you can do the following. | ||
|
||
1. Follow the `Installing for local development` instructions in the [CONTRIBUTING.md](./CONTRIBUTING.md) file. | ||
|
||
2. Add dependencies | ||
|
||
```bash | ||
uv sync --extra docs | ||
uv sync --all-extras | ||
``` | ||
|
||
2. Run the build | ||
|
||
3. Build the documentation | ||
```bash | ||
just docs | ||
``` | ||
|
||
3. Open `built_docs/html/index.html` in your browser, however you please | ||
4. Open the documentation in your browser of choice. | ||
|
||
If using something like VSCode's live server, open: | ||
|
||
```bash | ||
http://127.0.0.1:5500/built_docs/html/index.html | ||
``` | ||
|
||
Or: | ||
|
||
```bash | ||
/path/to/your/file/built_docs/html/index.html | ||
``` |
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