diff --git a/.gitignore b/.gitignore index f40fbd8..33f6175 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +.DS_Store _site .sass-cache .jekyll-cache diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml deleted file mode 100644 index f4dfd58..0000000 --- a/.gitlab-ci.yml +++ /dev/null @@ -1,29 +0,0 @@ -image: ruby:latest - -variables: - JEKYLL_ENV: production - LC_ALL: C.UTF-8 - -before_script: - - gem install bundler - - bundle install - -test: - stage: test - script: - - bundle exec jekyll build -d test - artifacts: - paths: - - test - rules: - - if: $CI_COMMIT_REF_NAME != $CI_DEFAULT_BRANCH - -pages: - stage: deploy - script: - - bundle exec jekyll build -d public - artifacts: - paths: - - public - rules: - - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH diff --git a/css/style.sass b/css/style.sass index 3031338..d27ec07 100644 --- a/css/style.sass +++ b/css/style.sass @@ -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 diff --git a/how-tos/how-tos.md b/how-tos/how-tos.md index 3d9c572..aa3361d 100644 --- a/how-tos/how-tos.md +++ b/how-tos/how-tos.md @@ -20,3 +20,8 @@ practical steps · problem-oriented · useful when working - [Creating variable components](#) - ... +### Documentation + +- [Reporting errors, suggesting changes, etc.](#) +- [Editing the documentation](#) +- ... diff --git a/index.md b/index.md index 1faf832..acd8a91 100644 --- a/index.md +++ b/index.md @@ -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) +
+ Quickstart ---------- @@ -29,7 +31,7 @@ About *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]: @@ -69,6 +71,9 @@ useful when working
+[Documentation System]: http://documentation.divio.com/ + + Links ----- @@ -89,4 +94,4 @@ Links - [fontra-glyphs](http://github.com/googlefonts/fontra-glyphs) - [fontra-compile](http://github.com/googlefonts/fontra-compile) - \ No newline at end of file + diff --git a/topics/documentation.md b/topics/documentation.md new file mode 100644 index 0000000..43f9de2 --- /dev/null +++ b/topics/documentation.md @@ -0,0 +1,121 @@ +--- +title: Documentation overview +layout: default +permalink: /topics/documentation/ +--- + + + +### 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 + + + +### 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 +``` + +
+
+##### 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 +
+
+##### 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.) +
+
diff --git a/topics/topics.md b/topics/topics.md index 0e5176c..633af7e 100644 --- a/topics/topics.md +++ b/topics/topics.md @@ -10,4 +10,5 @@ theoretical knowledge · understanding-oriented · useful when studying - [Welcome to Fontra](welcome-to-fontra) - [Workspace overview](workspace) - [Features overview](#) -- ... \ No newline at end of file +- [Documentation overview](documentation) +- ... diff --git a/topics/welcome.md b/topics/welcome.md index 209f58a..8418908 100644 --- a/topics/welcome.md +++ b/topics/welcome.md @@ -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 CJK fonts 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. diff --git a/topics/workspace.md b/topics/workspace.md index 09b439c..7a6ee4e 100644 --- a/topics/workspace.md +++ b/topics/workspace.md @@ -8,7 +8,7 @@ permalink: /topics/workspace/
  1. Index
  2. Topics
    3. -
  3. Workspace
    4. +
  4. {{ page.title }}
@@ -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. +