Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

Commit

Permalink
chore(workflows): add README.md for project (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
fuxingloh authored Oct 4, 2023
1 parent 6023e2b commit f0e2f1e
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ command line or within the Levain Launchpad (https://app.levain.tech).

### For Levainians

[//]: # '#### Adding & Managing Examples (https://examples.levain.dev)'

#### Adding & Managing Templates

Examples (`./examples/*`) that have frontmatter and `template:` configured will be compatible with the Levain Launchpad
Expand All @@ -25,6 +23,12 @@ This means that you can create a new project from the Levain Launchpad and selec
after whitelisting the example.
For more information on the available frontmatter options, see the `./examples/contented.config.mjs` file.

Accompanying prose should be added in the `README.md` as you would for any other project describing the example and how
to use it. The list of plugins for parsing and compiling the `README.md` is available in
the `./examples/contented.config.mjs` file.

> https://examples-frontmatter.levain.app contains all the examples and templates with prose compiled and rendered.
## Read the Docs

Levain examples are built on top of the Levain APIs. To learn more about the Levain APIs, check out
Expand Down

1 comment on commit f0e2f1e

@vercel
Copy link

@vercel vercel bot commented on f0e2f1e Oct 4, 2023

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.