Commit 4a049056 authored by Julian Gallimore's avatar Julian Gallimore
Browse files

Update mkdocs theme and config for 2021 cycle

parent 6fdde4c4
.env
_site
site/
.DS_Store
image: python:3.8-slim
before_script:
- pip install -r requirements.txt
# Install mkdocs and theme
- time pip install -r requirements.txt
test:
stage: test
script:
- time mkdocs build --strict --verbose --site-dir test
artifacts:
paths:
- test
except:
- master
pages:
stage: deploy
script:
- mkdocs build
- mv _site public
- time mkdocs build --site-dir public
artifacts:
paths:
- public
only:
- master
# Fabricademy student documentation
Visit [class.textile-academy.org](https://class.textile-academy.org/) for class and other information
or read the [Documentation Tutorial](http://fabricademy.fabcloud.io/gitlab-documentation-tutorial/) for more about this site.
* This website is built and published automatically using [GitLab CI](https://about.gitlab.com/gitlab-ci/), every time you edit the files in the docs folder
* The markdown content is generated into a site using the Mkdocs tool, a static site generator written in Python
* You can start by customizing the file `mkdocs.yml` with your information
* To change the looks of your website, use the theme options found in the `mkdocs.yml` file or see the names of the available themes
* If you want to start a website from scratch, you can delete everything in this repository and push your own static website
## Project layout
mkdocs.yml # The site configuration file.
docs/ # All site content/files should be in this folder.
index.md # The homepage.
files/ # Put files you'd like available in your site here (except videos)
images/ # You can put your images in here
... # Other markdown pages and folders
Read more about MkDocs at [mkdocs.org](http://www.mkdocs.org).
## Building locally
To work locally on your computer with this project, you can start with the following the steps:
1. Fork, clone or download this project
1. [Install](http://www.mkdocs.org/#installation) MkDocs on your computer
1. Preview your project: `mkdocs serve`, your site can be accessed under `localhost:8000`
1. To add new pages, create the markdown file in the `docs/` folder (i.e. `touch docs/about.md`)
1. Generate the website into a static site, `mkdocs build` (optional) Or just push your changes to GitLab
### Run with docker
For those that know how to use Docker, you can easily run mkdocs server without installing mkdocs.
Use this command with the Mkdocs-Material theme (see more info on [Docker Hub](https://hub.docker.com/r/squidfunk/mkdocs-material)).
```
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
```
# Replace the text below to customize your site
site_name: Your name
site_description: Your name Fabricademy site
site_url: https://class.textile-academy.org/2020/student.example/
repo_url: https://gitlab.fabcloud.org/academany/fabricademy/2020/students/student.example
site_author: Your name
docs_dir: docs
site_dir: _site
copyright: Copyright 2019 Your name - Creactive Commons Attribution Non-commercial
copyright: Copyright 2021 Your name - Creactive Commons Attribution Non-commercial
site_url: http://academany.fabcloud.io/fabricademy/2021/student-template/
repo_url: https://gitlab.fabcloud.org/academany/fabricademy/2021/student-template
repo_name: Edit on Fabcloud
extra:
social:
# For other social icons at https://squidfunk.github.io/mkdocs-material/setup/adding-social-links/
- icon: fontawesome/brands/instagram
link: https://instagram.com/fabricademy
- icon: fontawesome/brands/facebook
link: https://facebook.com/fabricademy
- icon: fontawesome/brands/twitter
link: https://twitter.com/fabricademy
theme:
name: material
# try other colors https://squidfunk.github.io/mkdocs-material/getting-started/#primary-colors
palette:
primary: "deep-purple"
accent: "deep-purple"
feature:
tabs: true
extra:
social:
# also facebook, pinterest, github are supported
- type: "instagram"
link: "https://instagram.com/squidfunk"
- type: "twitter"
link: "https://twitter.com/squidfunk"
- type: "linkedin"
link: "https://linkedin.com/in/squidfunk"
# try other colors https://squidfunk.github.io/mkdocs-material/getting-started/#primary-colors
primary: deep purple
accent: deep purple
font:
# See available fonts at https://fonts.google.com/
text: Roboto
code: Roboto Mono
icon:
logo: material/library
repo: material/gitlab
features:
- tabs
markdown_extensions:
- admonition
......
mkdocs
mkdocs-material<5.0
# Documentation static site generator
mkdocs >=1.1.2, ==1.1.*
# Add your custom theme if not inside a theme_dir
# (https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes)
mkdocs-material ~= 5.5
Supports Markdown
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