Skip to content

Commit 806008d

Browse files
committed
Update readme.md
1 parent afd8ca9 commit 806008d

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

readme.md

+13-9
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
1-
![Architect logo](https://github.com/architect/assets.arc.codes/raw/main/public/architect-logo-light-500b%402x.png#gh-dark-mode-only)
2-
![Architect logo](https://github.com/architect/assets.arc.codes/raw/main/public/architect-logo-500b%402x.png#gh-light-mode-only)
1+
<picture>
2+
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/architect/assets.arc.codes/raw/main/public/architect-logo-light-500b%402x.png">
3+
<img alt="Architect Logo" src="https://github.com/architect/assets.arc.codes/raw/main/public/architect-logo-500b%402x.png">
4+
</picture>
35

4-
## [`https://arc.codes`](https://arc.codes)
6+
<p align="center">
7+
<a href="https://github.com/architect/arc.codes/actions?query=workflow%3A%22Node+CI%22"><img src=https://github.com/architect/arc.codes/workflows/Node%20CI/badge.svg alt="GitHub CI status"></a>
8+
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="Apache-2.0 License"></a>
9+
</p>
510

6-
> Docs site for the OpenJS Architect framework!
7-
8-
[![GitHub CI status](https://github.com/architect/arc.codes/workflows/Node%20CI/badge.svg)](https://github.com/architect/arc.codes/actions?query=workflow%3A%22Node+CI%22)
11+
> Docs site for the OpenJS Architect framework!
12+
[`https://arc.codes`](https://arc.codes)
913

1014
## Docs Development
1115

12-
> ℹ️ We're actively improving Architect documentation, this repository, and this readme
16+
> ℹ️ We're actively improving Architect documentation, this repository, and this readme
1317
1418
This docs site is its own Architect project 🎉 so it can be run locally with `npx arc sandbox`
1519

@@ -19,13 +23,13 @@ The Sidebar is dynamically built from `table-of-contents.js` and the current sta
1923

2024
The Table of Contents (TOC) is a simple set of objects containing arrays of strings that correspond with Markdown documents.
2125

22-
> ⚠️ The fourth level of items will be grouped into a (closed by default) collapsible group. Use sparingly!
26+
> ⚠️ The fourth level of items will be grouped into a (closed by default) collapsible group. Use sparingly!
2327
2428
## Markdown & Frontmatter
2529

2630
All docs are written in Markdown.
2731

28-
The renderer combines [markdown-it](https://www.npmjs.com/package/markdown-it) and [frontmatter](https://www.npmjs.com/package/markdown-it-front-matter) to create HTML views.
32+
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.
2933

3034
The frontmatter attributes are technically optional but highly encouraged as they aid the site's SEO.
3135

0 commit comments

Comments
 (0)