Provides documentation for Qualified.
Configure git blame to ignore certain formatting commits:
git config blame.ignoreRevsFile .git-blame-ignore-revsFeel free to report issues. Pull requests are welcome.
Deploys are triggered automatically when merging into the master branch.
All project dependencies can be installed automatically by running
yarn installThis project uses Gridsome to develop the docs. You'll need to install gridsome globally, as in
npm install -g @gridsome/cli@0.3.4Then inside the repository, run this command
gridsome developAdditional documentation can be found here.
Prism.js syntax highlighting can be adjusted in MarkdownPage.vue.
The /content folder contains all markdown articles used within these docs. Each directory represents a level of depth. Up to 3 levels of depth are shown within the applications sidebar. The 2nd level of depth is treated only as a section header, so the only information the /content/[depth 1 folder]/[depth 2 folder]/index.html file should contain is title and order front-matter.
Internal markdown content links should be absolute (i.e. /foo) rather than relative (i.e. foo, ./foo, ../foo, etc), which can cause inconsistencies and broken links on some browsers. The command grep -RP '\]\((?!http|#|/|mailto)' content should return nothing.
The API docs are generated based on JSON files exported from the main Qualified Rails API. The JSON files live under /content/api.
Some icons were imported directly from the Qualified build output into the static directory as font files. The global.css file was generated by processing the common-icons.less file from the main project.
