![Architect Logo](https://github.com/architect/assets.arc.codes/raw/main/public/architect-logo-500b%402x.png?raw=true)
Docs site for the OpenJS Architect framework!
https://arc.codes
Docs Development
ℹ️ We're actively improving Architect documentation, this repository, and this readme
This docs site is its own Architect project npx arc sandbox
Table of Contents & Sidebar
The Sidebar is dynamically built from table-of-contents.js
and the current state.
The Table of Contents (TOC) is a simple set of objects containing arrays of strings that correspond with Markdown documents.
⚠️ The fourth level of items will be grouped into a (closed by default) collapsible group. Use sparingly!
Markdown & Frontmatter
All docs are written in Markdown.
The arcdown
renderer combines markdown-it (+ plugins) and frontmatter to create HTML views on the fly.
The frontmatter attributes are technically optional but highly encouraged as they aid the site's SEO.
attribute | type | effect |
---|---|---|
title | string |
HTML title |
category | string |
HTML title prefix |
description | string |
HTML meta description |
sections | string[] |
currently unused |
Todo
- dynamic category landing page
- writing style guide
- a homepage
dark mode