Skip to content

Commit

Permalink
switching font to Inria Sans, adding docs overview, deleting old gitl…
Browse files Browse the repository at this point in the history
…ab-ci file, etc
  • Loading branch information
gferreira committed Sep 13, 2023
1 parent 4a15ddc commit c6dd012
Show file tree
Hide file tree
Showing 9 changed files with 145 additions and 39 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.DS_Store
_site
.sass-cache
.jekyll-cache
Expand Down
29 changes: 0 additions & 29 deletions .gitlab-ci.yml

This file was deleted.

5 changes: 2 additions & 3 deletions css/style.sass
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,13 @@ excludeNavigation: true
---

@import "highlights"
@import url('https://fonts.googleapis.com/css2?family=Roboto+Flex&display=swap')

@import url('https://fonts.googleapis.com/css2?family=Inria+Sans:ital,wght@0,400;0,700;1,400;1,700&display=swap')

html
background-color: #222

body
font-family: 'Roboto Flex', sans-serif !important
font-family: 'Inria Sans', sans-serif !important
max-width: 960px
margin: 0 auto

Expand Down
5 changes: 5 additions & 0 deletions how-tos/how-tos.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,8 @@ practical steps · problem-oriented · useful when working
- [Creating variable components](#)
- ...

### Documentation

- [Reporting errors, suggesting changes, etc.](#)
- [Editing the documentation](#)
- ...
9 changes: 7 additions & 2 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@ It is developed by [Black\[Foundry\]](http://black-foundry.com/) & Just van Ross
read more in [Welcome to Fontra](topics/welcome-to-fontra)
</div>


<hr class="mt-5 mb-4">


Quickstart
----------

Expand All @@ -29,7 +31,7 @@ About
<i class="bi bi-exclamation-circle me-1"></i> *this is an unofficial work-in-progress user-contributed documentation*
{: .text-danger }

This documentation is structured according to the [Documentation System](http://documentation.divio.com/):
This documentation is structured according to the [Documentation System]:

<table class="table">
<tr>
Expand Down Expand Up @@ -69,6 +71,9 @@ useful when working
</tr>
</table>

[Documentation System]: http://documentation.divio.com/


Links
-----

Expand All @@ -89,4 +94,4 @@ Links
- [fontra-glyphs](http://github.com/googlefonts/fontra-glyphs)
- [fontra-compile](http://github.com/googlefonts/fontra-compile)
</div>
</div>
</div>
121 changes: 121 additions & 0 deletions topics/documentation.md
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>
3 changes: 2 additions & 1 deletion topics/topics.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ theoretical knowledge · understanding-oriented · useful when studying
- [Welcome to Fontra](welcome-to-fontra)
- [Workspace overview](workspace)
- [Features overview](#)
- ...
- [Documentation overview](documentation)
- ...
4 changes: 2 additions & 2 deletions topics/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ permalink: /topics/welcome-to-fontra/

Fontra is an open-source, browser-based, cross-platform, variable-first font editor. It is developed by Black[Foundry] and Just van Rossum with support from Google.

Fontra extends the boudaries of what current font editors can do. Originally developed to make the design and production of large CJK fonts more efficient, Fontra provides deeper integration of variable font technology and improved usability of variable components as design elements.
Fontra extends the boudaries of what current font editors can do. Originally developed to make the design and production of large <abr title="fonts with a large range of Chinese / Japanese / Korean characters">CJK fonts</abr> more efficient, Fontra provides deeper integration of variable font technology and improved usability of variable components as design elements.

Fontra is different from most other editors because it works in the browser. Using the Fontra Pak application, you can run Fontra locally to edit files on your computer. Fontra can also be used remotely from a server, allowing collaboration in real-time between multiple users.
Fontra is different from most other editors because it works in the browser. Using the [Fontra Pak](#) application, you can run Fontra locally to edit files on your computer. Fontra can also be used remotely from a server, allowing collaboration in real-time between multiple users.
7 changes: 5 additions & 2 deletions topics/workspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ permalink: /topics/workspace/
<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">Workspace</li>
<li class="breadcrumb-item active" aria-current="page">{{ page.title }}</li>
</ol>
</nav>

Expand All @@ -17,7 +17,10 @@ permalink: /topics/workspace/

### 1. Canvas

...
The canvas is where both font previewing and glyph editing takes place.

The current glyph can be viewed filled-in together with other glyphs of the same font.


<div class="alert alert-warning" role="alert" markdown='1'>
<i class="bi bi-exclamation-circle me-1"></i> Fontra does not have a *save* command – every change is saved!
Expand Down

0 comments on commit c6dd012

Please sign in to comment.