-
Notifications
You must be signed in to change notification settings - Fork 2
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
2 changed files
with
11 additions
and
4 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,8 +1,15 @@ | ||
# SRO Knowledgebase | ||
|
||
This is the SRO Knowledgebase, which can be [viewed here](https://sro.netlify.com). | ||
This is the SRO Knowledgebase, which can be [viewed here](https://kb.roboticsoutreach.org). | ||
|
||
It is built using [Mkdocs](https://www.mkdocs.org/) and should be as easy as writing Markdown. | ||
|
||
It is published automagically using Netlify. | ||
When you push changes and create a pull request, Netlify will create a preview version of the site accessible with a link from the pull request page. | ||
It is published automagically using GitHub Actions and GitHub Pages. | ||
|
||
Want to build your own copy of the knowledgebase? Clone the repository and run this: | ||
|
||
```bash | ||
pip install -r requirements.txt | ||
mkdocs build | ||
mkdocs serve | ||
``` |
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