-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #59 from algorandfoundation/docs/hand-crafted-docs
docs: hand crafted docs
- Loading branch information
Showing
48 changed files
with
9,177 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
File renamed without changes.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # build output | ||
| dist/ | ||
| # generated types | ||
| .astro/ | ||
|
|
||
| # dependencies | ||
| node_modules/ | ||
|
|
||
| # logs | ||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* | ||
| pnpm-debug.log* | ||
|
|
||
|
|
||
| # environment variables | ||
| .env | ||
| .env.production | ||
|
|
||
| # macOS-specific files | ||
| .DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| # Starlight Starter Kit: Tailwind | ||
|
|
||
| [](https://starlight.astro.build) | ||
|
|
||
| ``` | ||
| npm create astro@latest -- --template starlight/tailwind | ||
| ``` | ||
|
|
||
| [](https://stackblitz.com/github/withastro/starlight/tree/main/examples/tailwind) | ||
| [](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/tailwind) | ||
| [](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/tailwind) | ||
| [](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Ftailwind&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/ | ||
| │ └── content.config.ts | ||
| ├── astro.config.mjs | ||
| ├── package.json | ||
| ├── tailwind.config.mjs | ||
| └── 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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| // @ts-check | ||
| import { defineConfig } from 'astro/config'; | ||
| import starlight from '@astrojs/starlight'; | ||
| import tailwind from '@astrojs/tailwind'; | ||
|
|
||
| // https://astro.build/config | ||
| export default defineConfig({ | ||
| integrations: [ | ||
| starlight({ | ||
| title: 'NodeKit', | ||
| logo: { | ||
| src: './public/nodekit.png', | ||
| replacesTitle: true, | ||
| }, | ||
| social: { | ||
| github: 'https://github.com/withastro/starlight', | ||
| }, | ||
| sidebar: [ | ||
| { | ||
| label: 'Guides', | ||
| items: [ | ||
| // Each item here is one entry in the navigation menu. | ||
| { label: 'Example Guide', slug: 'guides/example' }, | ||
| ], | ||
| }, | ||
| { | ||
| label: 'Reference', | ||
| collapsed: true, | ||
| autogenerate: { directory: 'reference' }, | ||
| }, | ||
| ], | ||
| customCss: ['./src/tailwind.css'], | ||
| }), | ||
| tailwind({ applyBaseStyles: true }), | ||
| ], | ||
| }); |
Binary file not shown.
Oops, something went wrong.