leveljs.org's Introduction

leveljs.org

This is the source code for leveljs.org.

Stylus Structure

The Stylus files are located under assets/static/styl, with the following architecture...

├── assets
  └── styl
    ├── components
    ├── globals
    ├── pages
    ├── sections
    └── main.styl

Where:

compontents — are reusable components for common elements (such as buttons, forms, typography)
globals — reusable variables, mixins and base for the website
pages — subpages of the website (comments, profile, 404, landing, etc.)
sections - individual sections of a page (header, footer, community, platforms, etc.)

Template Structure

├── assets
  └── templates
    ├── index.pug
    ├── footer.pug
    └── layout.pug

Where:

layout.pug — basic layout file for the entire website
index.pug — the page content (here being the landing page)
footer.pug - footnotes

Contributing

Level/leveljs.org is an OPEN Open Source Project. This means that:

Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.

See the Contribution Guide for more details.

For contributors

git clone https://github.com/Level/leveljs.org.git
cd leveljs.org
npm i
npm start
# hack on the codez, send pull request

For maintainers

npm run deploy builds the static site, switches to the gh-pages branch and puts the built site in the root, and then does git push origin gh-pages.

git fetch
git checkout master # if you're not already on it
git merge <fork-branch>
npm run deploy

Donate

To sustain Level and its activities, become a backer or sponsor on Open Collective. Your logo or avatar will be displayed on our 28+ GitHub repositories and npm packages. 💖