-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
switching font to Inria Sans, adding docs overview, deleting old gitl…
…ab-ci file, etc
- Loading branch information
Showing
9 changed files
with
145 additions
and
39 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 |
---|---|---|
@@ -1,3 +1,4 @@ | ||
.DS_Store | ||
_site | ||
.sass-cache | ||
.jekyll-cache | ||
|
This file was deleted.
Oops, something went wrong.
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,121 @@ | ||
--- | ||
title: Documentation overview | ||
layout: default | ||
permalink: /topics/documentation/ | ||
--- | ||
|
||
<nav aria-label="breadcrumb"> | ||
<ol class="breadcrumb small"> | ||
<li class="breadcrumb-item"><a href="{{ site.url }}">Index</a></li> | ||
<li class="breadcrumb-item"><a href="../../topics">Topics</a></li> | ||
<li class="breadcrumb-item active" aria-current="page">{{ page.title }}</li> | ||
</ol> | ||
</nav> | ||
|
||
### How this documentation is written | ||
|
||
- try to use the tool, figure out how things work, ask questions to the developers | ||
- write it down as clearly as possible to pave the path for other users | ||
- with input from users and developers, make it better over time | ||
|
||
<div class="alert alert-warning" role="alert" markdown='1'> | ||
<i class="bi bi-exclamation-circle me-1"></i> keep the docs up-to-date in relation to the app! | ||
{: .mb-0 } | ||
</div> | ||
|
||
### How this documentation is structured | ||
|
||
- content is written and structured around the matrix proposed by the [Documentation System] | ||
- TL;DR: there are four types of documentation: *explanations*, *tutorials*, *how-tos*, *reference* | ||
- this system makes it easier for users to find what they are looking for, and for authors to expand and maintain the docs | ||
|
||
[Documentation System]: http://documentation.divio.com/ | ||
|
||
### How this documentation is built | ||
|
||
- documentation source is available as a [separate repository][fontra-docs] (public & open-source) | ||
- documentation website is built with [Jekyll] and served with [GitHub Pages] | ||
- content is written in [kramdown] \(markdown) with bits in html (tables) | ||
- templates are written in [Liquid] and laid out with [Bootstrap] | ||
- additional styles are written in [Sass] (custom font, custom classes) | ||
- the website is rebuilt automatically at every commit to the `main` branch of the repository | ||
|
||
[fontra-docs]: http://github.com/gferreira/fontra-docs | ||
[Jekyll]: http://jekyllrb.com/ | ||
[GitHub Pages]: http://pages.github.com/ | ||
[kramdown]: http://kramdown.gettalong.org/index.html | ||
[Liquid]: http://shopify.github.io/liquid/ | ||
[Bootstrap]: http://getbootstrap.com/ | ||
[Sass]: http://sass-lang.com/ | ||
|
||
{% comment %} | ||
### How to propose changes to the docs | ||
|
||
if you see a mistake or would like to propose an improvement: | ||
|
||
- create an issue on the `fontra-docs` repository | ||
- send a message on [Discord](#) with the label `docs` | ||
- fork the `fontra-docs` repository and submit a pull request | ||
{% endcomment %} | ||
|
||
### How the repository is structured | ||
|
||
``` | ||
fontra-docs | ||
├── _includes/ | ||
├── _layouts/ | ||
├── _py/ | ||
├── css/ | ||
├── images/ | ||
├── reference/ | ||
├── topics/ | ||
├── tutorials/ | ||
├── how-tos/ | ||
├── index.md | ||
└── 404.html | ||
``` | ||
|
||
<div class='row'> | ||
<div class='col-md' markdown='1'> | ||
##### System | ||
|
||
\_includes | ||
: modular template parts such as header and footer | ||
|
||
\_layouts | ||
: just a single `default.html` template for now | ||
|
||
\_py | ||
: Python scripts used to create images, etc. | ||
|
||
css | ||
: contains `style.sass` with custom styles only | ||
|
||
404.html | ||
: page for *Page not found* errors | ||
|
||
\_config.yml | ||
: Jekyll configuration file with project metadata | ||
</div> | ||
<div class='col-md' markdown='1'> | ||
##### Content | ||
|
||
reference | ||
: sources for pages in the *Reference* section | ||
|
||
topics | ||
: sources for pages in the *Topics* section | ||
|
||
tutorials | ||
: sources for pages in the *Tutorials* section | ||
|
||
how-tos | ||
: sources for pages in the *How-Tos* section | ||
|
||
index.md | ||
: home page of the documentation | ||
|
||
images | ||
: all images (screenshots, icons, etc.) | ||
</div> | ||
</div> |
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
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