added link to github. simplified README.
This commit is contained in:
parent
649cf3f189
commit
39abbca149
2 changed files with 7 additions and 103 deletions
107
README.md
107
README.md
|
|
@ -1,106 +1,7 @@
|
|||
# Starlight Starter Kit: Basics
|
||||
# ISPmail guide
|
||||
|
||||
[](https://starlight.astro.build)
|
||||
This repository holds the ISPmail guide as found on workaround.org.
|
||||
|
||||
```
|
||||
npm create astro@latest -- --template starlight
|
||||
```
|
||||
It was built using the static site generator [Starlight](https://starlight.astro.build).
|
||||
|
||||
[](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
|
||||
[](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
|
||||
[](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
|
||||
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
|
||||
|
||||
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
|
||||
|
||||
## 🚀 Project Structure
|
||||
|
||||
Inside of your Astro + Starlight project, you'll see the following folders and files:
|
||||
|
||||
```
|
||||
.
|
||||
├── public/
|
||||
├── src/
|
||||
│ ├── assets/
|
||||
│ ├── content/
|
||||
│ │ ├── docs/
|
||||
│ │ └── config.ts
|
||||
│ └── env.d.ts
|
||||
├── astro.config.mjs
|
||||
├── package.json
|
||||
└── tsconfig.json
|
||||
```
|
||||
|
||||
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
|
||||
|
||||
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
|
||||
|
||||
Static assets, like favicons, can be placed in the `public/` directory.
|
||||
|
||||
## 🧞 Commands
|
||||
|
||||
All commands are run from the root of the project, from a terminal:
|
||||
|
||||
| Command | Action |
|
||||
| :------------------------ | :----------------------------------------------- |
|
||||
| `npm install` | Installs dependencies |
|
||||
| `npm run dev` | Starts local dev server at `localhost:4321` |
|
||||
| `npm run build` | Build your production site to `./dist/` |
|
||||
| `npm run preview` | Preview your build locally, before deploying |
|
||||
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
|
||||
| `npm run astro -- --help` | Get help using the Astro CLI |
|
||||
|
||||
## 👀 Want to learn more?
|
||||
|
||||
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
|
||||
|
||||
## Todo
|
||||
|
||||
Offer a way to collate all pages into one for PDF/printing.
|
||||
|
||||
- https://github.com/withastro/starlight/discussions/964
|
||||
|
||||
Additional links in navbar:
|
||||
|
||||
- https://starlight-utils.pages.dev/utilities/nav-links/
|
||||
|
||||
Colors:
|
||||
|
||||
- https://github.com/withastro/starlight/blob/a1926ce87b43aaa25b9063f9776e8e4ffabed88d/packages/starlight/style/props.css#L2
|
||||
|
||||
Quiz:
|
||||
|
||||
|
||||
<Box icon="question-mark">
|
||||
|
||||
## Test your knowledge
|
||||
|
||||
Which of the following is a code editor, for making changes to your files and their content?
|
||||
|
||||
<MultipleChoice>
|
||||
<Option>
|
||||
web browser
|
||||
</Option>
|
||||
<Option>
|
||||
Terminal
|
||||
</Option>
|
||||
<Option isCorrect>
|
||||
VS Code
|
||||
</Option>
|
||||
</MultipleChoice>
|
||||
|
||||
Which of the following is a code editor, for making changes to your files and their content?
|
||||
|
||||
<MultipleChoice>
|
||||
<Option>
|
||||
web browser
|
||||
</Option>
|
||||
<Option>
|
||||
Terminal
|
||||
</Option>
|
||||
<Option isCorrect>
|
||||
VS Code
|
||||
</Option>
|
||||
</MultipleChoice>
|
||||
|
||||
</Box>
|
||||
More information on how to contribute will follow.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue