Commit 9648b12c authored by Julian Gallimore's avatar Julian Gallimore
Browse files

Update template to latest Material theme version 6

parent 3da048fa
Pipeline #241348 passed with stage
in 34 seconds
image: python:alpine
image: python:3.8-slim
before_script:
# install Git for the mkdocs revision plugin
- time apt update && apt-get install -y git
# Install mkdocs and theme
- time pip install -r requirements.txt
test:
stage: test
script:
- time mkdocs build --site-dir test
artifacts:
paths:
- test
except:
- master
pages:
stage: deploy
variables:
GIT_DEPTH: 1000
script:
- time mkdocs build
- time mv _site public
- time mkdocs build --site-dir public
artifacts:
paths:
- public
only:
- master
## Welcome to your new Fab Academy site
- This website is built automatically by gitlab every time you edit the files in the docs folder
- It does so thanks to [Mkdocs](https://mkdocs.org) a static site generator written in Python
- You must start customizing the file mkdocs.yml with your information
- You can change the looks of your website using mkdocs themes, you can find in the mkdocs.yml the names of the available themes
- If you want to start from scratch, you can delete everything in this repository and push any other static website
Visit [fabacademy.org](https://fabacademy.org/) for class and other information.
* 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
abc.md... # Other markdown pages and folders
Read more about MkDocs at [mkdocs.org](http://www.mkdocs.org).
## Building mkdocs locally
To work locally on your computer with this project, you can start with the following the steps:
> Remember to setup your SSH keys to work locally, see [GitLab Docs](https://docs.gitlab.com/ee/gitlab-basics/create-your-ssh-keys.html)
1. Clone or download this project on your computer
* Find the clone url at the top of your projects "overview" page
* Run `git clone git@gitlab.fabcloud.org:your/project/path.git`
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. Push your changes to GitLab to automatically publish your changes
* `git commit -m "Updated site"`
* `git push master`
#### Git global setup
Do not forget to configure your local git environment, with same details used on Gitlab-Fabcloud.
```
git config user.name "You Name"
git config user.email "you@example.org"
```
......@@ -59,3 +59,53 @@ void loop() {
on <a href="https://sketchfab.com?utm_medium=embed&utm_source=website&utm_campaign=share-popup" target="_blank" style="font-weight: bold; color: #1CAAD9;">Sketchfab</a>
</p>
</div>
## Use HTML
You may also embed HTML in your markdown files
<hr />
Try having a seperator line
<hr />
<table border="1">
<thead>
<tr>
<th>ID</th>
<th>First Name</th>
<th>Last Name</th>
</tr>
</thead>
<tbody>
<tr>
<td>235312</td>
<td>John</td>
<td>Doe</td>
</tr>
<tr>
<td>453123</td>
<td>Mark</td>
<td>Jones</td>
</tr>
<tr>
<td>998332</td>
<td>Jonathan</td>
<td>Smith</td>
</tr>
<tr>
<td>345612</td>
<td>Andrew</td>
<td>McArthur</td>
</tr>
<tr>
<td>453123</td>
<td>Adam</td>
<td>Fuller</td>
</tr>
</tbody>
</table>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 3L1 9l11 6 9-4.91V17h2V9M5 13.18v4L12 21l7-3.82v-4L12 17l-7-3.82z"/></svg>
# Replace the text below to customize your site
site_name: Fab Academy Student Name
site_description: My Fabacademy site
site_name: Your name - Fab Academy
site_description: Fab Academy documentation site for Your Name
site_author: Your name
copyright: Copyright 2021 Your name - Creative Commons Attribution Non Commercial
site_url: http://fibasile.fabcloud.io/fabacademy-student-template/
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/fabacademany
- icon: fontawesome/brands/facebook
link: https://facebook.com/fabacademany
- icon: fontawesome/brands/twitter
link: https://twitter.com/fabacademany
- icon: fontawesome/brands/linkedin
link: "https://linkedin.com/in/academany"
site_author: Your name here
docs_dir: docs
site_dir: _site
copyright: Creative Commons Attribution Non Commercial
theme:
name: material
# see https://squidfunk.github.io/mkdocs-material/getting-started/#color-palette
palette:
primary: "deep"
accent: "indigo"
# try other colors https://squidfunk.github.io/mkdocs-material/getting-started/#primary-colors
primary: deep
accent: indigo
font:
false
# text: "Ubuntu"
# code: "Ubuntu Mono"
feature:
tabs: true
extra:
social:
- type: "github"
link: "https://github.com/academany"
- type: "twitter"
link: "https://twitter.com/fabacademany"
- type: "linkedin"
link: "https://linkedin.com/in/academany"
- type: "instagram"
link: "https://instagram.com/fabacademany"
# See available fonts at https://fonts.google.com/
text: Ubuntu
code: Ubuntu Mono
icon:
logo: material/school
favicon: images/favicon.svg
features:
- navigation.tabs
- navigation.instant
plugins:
- search
- git-revision-date-localized:
fallback_to_build_date: true
markdown_extensions:
- extra
......
mkdocs-material
\ No newline at end of file
# Documentation static site generator
mkdocs >=1.1.2, ==1.1.*
mkdocs-git-revision-date-localized-plugin ~= 0.8.0
# Add your custom theme if not inside a theme_dir
# (https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes)
mkdocs-material ~= 6.2
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