Code Monkey home page Code Monkey logo

arc.codes's Introduction

Docs site for the Architect serverless framework!

GitHub CI status

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 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 renderer combines markdown-it and frontmatter to create HTML views.

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

arc.codes's People

Contributors

brianleroux avatar tbeseda avatar kristoferjoseph avatar macdonst avatar ryanblock avatar filmaj avatar shawnhosea avatar ankcorn avatar reconbot avatar andybee avatar mawdesley avatar retzloff avatar emtilmont avatar ryanbethel avatar activescott avatar beginci avatar herschel666 avatar rubiconjosh avatar mikemaccana avatar oliverturner avatar wookiehangover avatar actsone8 avatar dependabot-preview[bot] avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.