Commit 21dee653 authored by David Trudgian's avatar David Trudgian
Browse files

Some tidying up

parent 5963aecc
Pipeline #8244 failed with stage
in 20 seconds
---
Example [MkDocs] website using GitLab Pages on BioHPC
## Example [MkDocs] website using GitLab Pages on BioHPC
Learn more about GitLab Pages at https://pages.gitlab.io and the official
documentation https://docs.gitlab.com/ce/user/project/pages/.
---
## Structure
......
# Welcome to MkDocs
This is a test site hosted on [GitLab Pages](https://pages.gitlab.io). You can
[browse its source code](https://gitlab.com/pages/mkdocs), fork it and start
This is a test site hosted on BioHPC Gitlab Pages
[browse its source code](https://git.biohpc.swmed.edu/biohpc/mkdocs_pages_example), fork it and start
using it on your projects.
For full documentation visit [mkdocs.org](http://mkdocs.org).
For full documentation on the mkdocs system visit [mkdocs.org](http://mkdocs.org).
## Commands
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs help` - Print this help message.
## Project layout
......@@ -19,3 +13,29 @@ For full documentation visit [mkdocs.org](http://mkdocs.org).
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
## Building locally
To work locally with this project on a BioHPC machine, you'll have to follow the steps below:
1. Fork, clone or download this project
1. Load the anaconda python module `module add python/2.7.x-anaconda`
1. Install the python mkdocs package to your home dir `pip install --user mkdocs`
1. Preview your project: `mkdocs serve`,
your site can be accessed under `localhost:8000`
1. Add content
## Local Mkdocs Commands
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site into a folder (CI does this automatically for the Gitlab Pages site)
* `mkdocs help` - Print this help message.
## GitLab CI
This project's static Pages are built by [GitLab CI][ci], following the steps
defined in `.gitlab-ci.yml`
\ No newline at end of file
site_name: Example GitLab Pages with Mkdocs
site_url: https://pages.biohpc.swmed.edu/mkdocs_pages_example
theme: readthedocs
site_url: https://biohpc.pages.biohpc.swmed.edu/mkdocs_pages_example
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment