Skip to content

Commit

Permalink
docs: multi-page content (#118)
Browse files Browse the repository at this point in the history
  • Loading branch information
ignatiusmb committed Jan 16, 2024
1 parent b013a26 commit 2965b0e
Show file tree
Hide file tree
Showing 35 changed files with 1,008 additions and 539 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The easiest way to contribute! By just using the software, you're already helpin

## Documentation

Documentation is especially helpful! You can add something that hasn't been covered or is missing in the docs and help guide others with your experience. The source for the documentation lives in the [content](content) directory.
Documentation is especially helpful! You can add something that hasn't been covered or is missing in the docs and help guide others with your experience. The source for the documentation lives in the [workspace/content](workspace/content) directory.

## Developing

Expand All @@ -35,14 +35,14 @@ The first script to run is `"watch"` in `workspace/marqua`, this will compile an

How the project and code is structured, and some entry points to be aware of

- `content` - unprocessed markdown files containing all of the documentation
- `workspace/content` - unprocessed markdown files containing all of the documentation
- `workspace/marqua/src/core` - marqua core module, compiler components
- `workspace/marqua/src/artisan` - marqua artisan module, syntax highlighter and marker
- `workspace/marqua/src/browser` - marqua browser module, DOM hydrating function
- `workspace/marqua/src/fs` - marqua file system module, read markdown files from disk
- `workspace/marqua/src/transform` - marqua transform module, transformers for `traverse`
- `workspace/marqua/styles` - stylesheets used and exported
- `workspace/documentation` - source code for the website
- `workspace/website` - source code for the website

## Maintaining

Expand Down
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# Marqua ![Total npm downloads](https://img.shields.io/npm/dt/marqua) · ![Published npm version](https://img.shields.io/npm/v/marqua) ![Monthly npm downloads](https://img.shields.io/npm/dm/marqua) ![License](https://img.shields.io/github/license/ignatiusmb/marqua)

Augmented Markdown Compiler. Write markdown files and convert them into structured data and markup.

- Visit the documentation site at <https://marqua.mauss.dev> to get started.
- See <https://github.com/ignatiusmb/marqua/releases> tab to stay updated.
- Visit the documentation at <https://marqua.mauss.dev> to learn more.
- See <https://github.com/ignatiusmb/marqua/releases> to stay updated.

## Contributing

Expand Down

1 comment on commit 2965b0e

@vercel
Copy link

@vercel vercel bot commented on 2965b0e Jan 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.