generated from google/docsy-example
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from catalystneuro/feature/landing-page-update
Feature/landing page update
- Loading branch information
Showing
8 changed files
with
25 additions
and
102 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
This file was deleted.
Oops, something went wrong.
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
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
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
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
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 |
---|---|---|
|
@@ -8,26 +8,15 @@ is missing or unclear, let us know by [opening an issue on our helpdesk](https:/ | |
|
||
## Serving the Docs Locally | ||
|
||
This project uses the [MkDocs](https://www.mkdocs.org/) tool with the [Material theme](https://squidfunk.github.io/mkdocs-material/) | ||
and extra plugins to generate the website. | ||
This project uses the [Hugo](https://gohugo.io/) to generate the website. To test locally, you will need to install Hugo. | ||
|
||
To test locally, you will need to install the Python dependencies. To do that, type the following commands: | ||
To run a local server, type the following commands: | ||
|
||
``` | ||
git clone https://github.com/dandi/handbook.git | ||
cd handbook | ||
pip install -r requirements.txt | ||
git clone https://github.com/dandi/dandi.github.io.git | ||
cd dandi.github.io | ||
hugo server | ||
``` | ||
|
||
If you are working on your *fork*, simply replace `https://github.com/dandi/handbook.git` | ||
with `git clone [email protected]/<username>/handbook.git` , where `<username>` is your | ||
GitHub username. | ||
|
||
Once done, you need to run MkDocs. Simply type: | ||
|
||
``` | ||
mkdocs serve | ||
``` | ||
|
||
Finally, open [`http://127.0.0.1:8000/`](http://127.0.0.1:8000/) in your | ||
Finally, open [`http://127.0.0.1:1313/`](http://127.0.0.1:1313/) in your | ||
browser, and you should see the default home page of the documentation being displayed. |
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