-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: move adv stuff out of readme (#125)
- Loading branch information
1 parent
96c97f2
commit e463dd3
Showing
3 changed files
with
15 additions
and
3 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 |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# How to Develop | ||
|
||
Manage dependencies via [TACC/TACC-Docs](https://github.com/TACC/TACC-Docs). Serve docs via [MkDocs](https://www.mkdocs.org/). Test via [Docker](https://www.docker.com/). Deploys are [automated](./PUBLISHING.md). | ||
|
||
## Theming | ||
|
||
Customize MkDocs with [CSS, JS, ES, plugins, extensions](https://github.com/TACC/TACC-Docs/blob/v0.15.0/mkdocs.base.yml) and [theme overrides](https://github.com/TACC/TACC-Docs/tree/v0.15.0/themes/tacc-readthedocs) **from [TACC/TACC-Docs](https://github.com/TACC/TACC-Docs)** both via [script](./bin/tacc-setup.sh) and [via Docker](./Dockerfile). | ||
|
||
To theme another MkDocs project to look [like this](https://docs.tacc.utexas.edu/), please contact [@wesleyboar](https://www.github.com/wesleyboar). | ||
|
||
> [!NOTE] | ||
> We will eventually [use MkDocs Material](https://github.com/TACC/TACC-Docs/issues/53) and [apply TACC customization properly](https://github.com/TACC/TACC-Docs/issues/76). |
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