Skip to content
This is a design system documentation powered by eleventy
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src changed the wording to "we" and fixed some typos Apr 19, 2019
.editorconfig
.eleventy.js add modified date Apr 16, 2019
.gitignore init Apr 11, 2019
.stylelintignore init Apr 11, 2019
.stylelintrc.json init Apr 11, 2019
LICENSE Initial commit Apr 11, 2019
README.md
gulpfile.js added images where missing Apr 17, 2019
icon.png change icon to reflect it's a system Apr 17, 2019
package-lock.json fix package.json information Apr 16, 2019
package.json fix package.json information Apr 16, 2019

README.md

This is a design system documentation powered by eleventy

It is structured using ITCSS and uses BEM for the styling.

The Story

Some time ago I decided to redesign my personal website and remove things like wordpress. Since I'm aobsessed with speed and optimization while enabling maximum flexibility with my code I decided to...

  • use a static site generator
  • write my own framework and not use things like bootstrap

Since I'm following Zach Leatherman on twitter I heard about him developing eleventy. After my site was done I decided to use eleventy as a documentation generator for my code.

If you're interested in Pattern Libraries or Design Systems like me, you could use this repository to build your own pattern lib. Just fork it and use it as a starting point and extend it to adopt your needs.

Techniques

You might notice, that I'm using ITCSS and BEM here. Currently there's no JS here, but that might change. My goal is to avoid frameworks as much as possible, so jQuery might not be used here.

HOW TO

The only things you need to edit are the contents in the folder src/eleventy/pages

Opening this folder, you might notice, there are folders using the ITCSS-Names (prefixed with numbers to reflect the hierarchy).

  • 1-settings (does not exist)
  • 2-tools (does not exist)
  • 3-generic (does not exist)
  • 4-elements
  • 5-objects
  • 6-components
  • 7-utilities
  • themes (not ITCSS but used to edit some styles for the documentation)

In any of these folders (except "themes"), there are the files needed for the documentation.

  • code.html
    • used to generate the previews and code-snippets
  • description.md
    • add some description to your code

All content in these folders are automatically grouped on one page.

The sidebar is dynamically filled with links which link to the equivalent parts on the page (using IDs). Names in the sidebare come from the equivalent directory-name so no Front Matter data is used here. Keep that in mind, when choosing names.

Prefixes

The CSS is prefixed so we can mix it with other frameworks and identify the classes later on. You can change the pprefix in src/assets/scss/1-settings/variables. But keep in mind, that you need to change the class-names in the html too. Search for sdi-and replace it with a name you like best.

Gulp

I'm using gulp as a task runner so you need node.js and gulp.

  1. just install node.js
  2. and run npm install in the project directory

Here's a list of available tasks

  • gulp serve runs eleventy and starts the watcher
  • gulp update lints and recompiles CSS & JS. Calls the copy-function too
  • gulp build runs eleventy and all build tasks without starting it
  • gulp copy to copy required files (normally not required to run manually)
  • gulp lint lints your scss using stylelint (it's very strict)
  • gulp build:css rebuilds the CSS

Code Highlighting

We're using prism.js to highlight the code. The nesseccary files are included in this repository. If you want to change the styling head to https://prismjs.com/ and download the files you want. After that place them in src/assets/3rdparty/prism and run gulp build

You can’t perform that action at this time.