Skip to content

architect/arc.codes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Jan 2, 2025
9f1e134 Β· Jan 2, 2025
Jan 2, 2025
Nov 12, 2024
Nov 12, 2024
Jan 2, 2025
May 6, 2024
May 3, 2024
Apr 27, 2022
Oct 7, 2020
Aug 15, 2024
Jan 2, 2025
Jan 2, 2025
Jan 2, 2025
May 30, 2022
May 7, 2024

Repository files navigation

Architect Logo

GitHub CI status Apache-2.0 License

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 πŸŽ‰ so it can be run locally with 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

Contributing

Find out more about contributing to Architect