Skip to content

chore: fix typos in README.md #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pranavkonde wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: fix typos in README.md #32

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a188679
Update README.md
pranavkonde Jan 27, 2025
84a4096
Update README.md
pranavkonde Apr 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ Built on next, the pages live in `src/app`. See https://nextjs.org/docs/app

Add pages as markdown with .md extension to `src/pages`

The path to the file is used as the url, e.g. `src/pages/w3cli.mdx` -> `/w3cli`.
The path to the file is used as the URL, e.g. `src/pages/w3cli.mdx` -> `/w3cli`.

The `_meta.json` in the directory defines the order of links in the sidebar and the values set their link text.

Update the `_meta.json` file in the directory when you add a new page. There should be one in each sub directory.
Update the `_meta.json` file in the directory when you add a new page. There should be one in each sub-directory.


`src/pages/_meta.json`
Expand All @@ -53,13 +53,13 @@ Update the `_meta.json` file in the directory when you add a new page. There sho

In the above:
- `"pail"` is a hidden section, allowing us to add docs that we don't want to publish yet.
- `"specs"` ads a sidebar link to the github repo, there is no associated markdown file here.
- `"specs"` adds a sidebar link to the github repo, there is no associated markdown file here.

Docs section is built on nextra. See https://nextra.site/docs/guide/organize-files for more.

### Links

To link to other pages using the root relative url in a standard markdown link. To link to the w3cli.md from the quickstart page, your would include:
To link to other pages using the root relative URL in a standard markdown link. To link to the w3cli.md from the quickstart page, you would include:

**quickstart.md**
```md
Expand Down
Loading