https://github.com/architect/arc.codes

The Architect web site! 🌩
https://github.com/architect/arc.codes

api-gateway arc aws docs dynamodb lambda sns

Last synced: about 2 months ago
JSON representation

The Architect web site! 🌩

• Host: GitHub
• URL: https://github.com/architect/arc.codes
• Owner: architect
• License: apache-2.0
• Created: 2017-07-20T22:51:22.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-05-14T21:34:08.000Z (4 months ago)
• Last Synced: 2024-06-01T22:48:36.274Z (4 months ago)
• Topics: api-gateway, arc, aws, docs, dynamodb, lambda, sns
• Language: JavaScript
• Homepage: https://arc.codes
• Size: 16.9 MB
• Stars: 312
• Watchers: 11
• Forks: 96
• Open Issues: 13
• Metadata Files:
  • Readme: readme.md
  • Contributing: .github/contributing.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        

  

  



  

  



> Docs site for the OpenJS Architect framework!  

[`https://arc.codes`](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](https://github.com/architect/arcdown) combines [markdown-it](https://www.npmjs.com/package/markdown-it) (+ plugins) and [frontmatter](https://www.npmjs.com/package/markdown-it-front-matter) 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](https://arc.codes/docs/en/about/contribute)