Browse Source

Added extension to fix note blocks and added more instructions

creds
Cameron Weinfurt 3 years ago
parent
commit
caa1c50e27
  1. 5
      docs/index.md
  2. 3
      mkdocs.yml

5
docs/index.md

@ -3,6 +3,7 @@
Information about infrastructure, services and about the labs in general can be found throughout the site.
!!! Warning
As this site is under construction, some information may not be present. The most up to date documentation can be found on our [Gitea instance](https://gitea.cosi.clarkson.edu). Older documentation may be found on the [older documentation server](https://docs.cosi.clarkson.edu).
## Contributing to info/
@ -13,4 +14,6 @@ COSI is a living-learning community. In order to help lab members (past, present
To contribute to info/, make sure you have an LDAP account on the COSI network. If you do not have one, contact an available sysadmin and they will create one for you.
Once you have an LDAP account, clone down the [info-slash repository](https://gitea.cslabs.clarkson.edu/COSI_Sysadmins/info-slash) and make modifications to your local copy. Commit and push your changes to have them be saved to the repository. To deploy your changes, run `mkdocs gh-deploy` and your changes will appear on info/ within 10 minutes.
In addition, you will need to install `mkdocs` on your system. Refer to [https://www.mkdocs.org/#installation](https://www.mkdocs.org/#installation) for installation instructions.
Once you have an LDAP account, clone down the [info-slash repository](https://gitea.cslabs.clarkson.edu/COSI_Sysadmins/info-slash) and make modifications to your local copy. You can preview your changes by running `mkdocs serve` and then viewing [`localhost:8000`](localhost:8000) in your browser. Commit and push your changes to have them be saved to the repository. To deploy your changes, run `mkdocs gh-deploy` and your changes will appear on info/ within 10 minutes.

3
mkdocs.yml

@ -1 +1,4 @@
site_name: My Docs
markdown_extensions:
- admonition
Loading…
Cancel
Save