development_docs_inca_basic #100
							
								
								
									
										21
									
								
								docs_projectinca/.gitignore
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										21
									
								
								docs_projectinca/.gitignore
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -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 | ||||||
							
								
								
									
										54
									
								
								docs_projectinca/README.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										54
									
								
								docs_projectinca/README.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,54 @@ | |||||||
|  | # Starlight Starter Kit: Basics | ||||||
|  |  | ||||||
|  | [](https://starlight.astro.build) | ||||||
|  |  | ||||||
|  | ``` | ||||||
|  | npm create astro@latest -- --template starlight | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | [](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics) | ||||||
|  | [](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/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). | ||||||
							
								
								
									
										27
									
								
								docs_projectinca/astro.config.mjs
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										27
									
								
								docs_projectinca/astro.config.mjs
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,27 @@ | |||||||
|  | import { defineConfig } from 'astro/config'; | ||||||
|  | import starlight from '@astrojs/starlight'; | ||||||
|  |  | ||||||
|  | // https://astro.build/config | ||||||
|  | export default defineConfig({ | ||||||
|  | 	integrations: [ | ||||||
|  | 		starlight({ | ||||||
|  | 			title: 'My Docs', | ||||||
|  | 			social: { | ||||||
|  | 				github: 'https://github.com/withastro/starlight', | ||||||
|  | 			}, | ||||||
|  | 			sidebar: [ | ||||||
|  | 				{ | ||||||
|  | 					label: 'Guides', | ||||||
|  | 					items: [ | ||||||
|  | 						// Each item here is one entry in the navigation menu. | ||||||
|  | 						{ label: 'Example Guide', link: '/guides/example/' }, | ||||||
|  | 					], | ||||||
|  | 				}, | ||||||
|  | 				{ | ||||||
|  | 					label: 'Reference', | ||||||
|  | 					autogenerate: { directory: 'reference' }, | ||||||
|  | 				}, | ||||||
|  | 			], | ||||||
|  | 		}), | ||||||
|  | 	], | ||||||
|  | }); | ||||||
							
								
								
									
										19
									
								
								docs_projectinca/package.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										19
									
								
								docs_projectinca/package.json
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,19 @@ | |||||||
|  | { | ||||||
|  |   "name": "", | ||||||
|  |   "type": "module", | ||||||
|  |   "version": "0.0.1", | ||||||
|  |   "scripts": { | ||||||
|  |     "dev": "astro dev", | ||||||
|  |     "start": "astro dev", | ||||||
|  |     "build": "astro check && astro build", | ||||||
|  |     "preview": "astro preview", | ||||||
|  |     "astro": "astro" | ||||||
|  |   }, | ||||||
|  |   "dependencies": { | ||||||
|  |     "@astrojs/starlight": "^0.24.1", | ||||||
|  |     "astro": "^4.8.6", | ||||||
|  |     "sharp": "^0.32.5", | ||||||
|  |     "@astrojs/check": "^0.7.0", | ||||||
|  |     "typescript": "^5.4.5" | ||||||
|  |   } | ||||||
|  | } | ||||||
							
								
								
									
										1
									
								
								docs_projectinca/public/favicon.svg
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								docs_projectinca/public/favicon.svg
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1 @@ | |||||||
|  | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><path fill-rule="evenodd" d="M81 36 64 0 47 36l-1 2-9-10a6 6 0 0 0-9 9l10 10h-2L0 64l36 17h2L28 91a6 6 0 1 0 9 9l9-10 1 2 17 36 17-36v-2l9 10a6 6 0 1 0 9-9l-9-9 2-1 36-17-36-17-2-1 9-9a6 6 0 1 0-9-9l-9 10v-2Zm-17 2-2 5c-4 8-11 15-19 19l-5 2 5 2c8 4 15 11 19 19l2 5 2-5c4-8 11-15 19-19l5-2-5-2c-8-4-15-11-19-19l-2-5Z" clip-rule="evenodd"/><path d="M118 19a6 6 0 0 0-9-9l-3 3a6 6 0 1 0 9 9l3-3Zm-96 4c-2 2-6 2-9 0l-3-3a6 6 0 1 1 9-9l3 3c3 2 3 6 0 9Zm0 82c-2-2-6-2-9 0l-3 3a6 6 0 1 0 9 9l3-3c3-2 3-6 0-9Zm96 4a6 6 0 0 1-9 9l-3-3a6 6 0 1 1 9-9l3 3Z"/><style>path{fill:#000}@media (prefers-color-scheme:dark){path{fill:#fff}}</style></svg> | ||||||
| After Width: | Height: | Size: 696 B | 
							
								
								
									
										
											BIN
										
									
								
								docs_projectinca/src/assets/houston.webp
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs_projectinca/src/assets/houston.webp
									
									
									
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							| After Width: | Height: | Size: 96 KiB | 
							
								
								
									
										6
									
								
								docs_projectinca/src/content/config.ts
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								docs_projectinca/src/content/config.ts
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,6 @@ | |||||||
|  | import { defineCollection } from 'astro:content'; | ||||||
|  | import { docsSchema } from '@astrojs/starlight/schema'; | ||||||
|  |  | ||||||
|  | export const collections = { | ||||||
|  | 	docs: defineCollection({ schema: docsSchema() }), | ||||||
|  | }; | ||||||
							
								
								
									
										11
									
								
								docs_projectinca/src/content/docs/guides/example.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										11
									
								
								docs_projectinca/src/content/docs/guides/example.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,11 @@ | |||||||
|  | --- | ||||||
|  | title: Example Guide | ||||||
|  | description: A guide in my new Starlight docs site. | ||||||
|  | --- | ||||||
|  |  | ||||||
|  | Guides lead a user through a specific task they want to accomplish, often with a sequence of steps. | ||||||
|  | Writing a good guide requires thinking about what your users are trying to do. | ||||||
|  |  | ||||||
|  | ## Further reading | ||||||
|  |  | ||||||
|  | - Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework | ||||||
							
								
								
									
										36
									
								
								docs_projectinca/src/content/docs/index.mdx
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										36
									
								
								docs_projectinca/src/content/docs/index.mdx
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,36 @@ | |||||||
|  | --- | ||||||
|  | title: Welcome to Starlight | ||||||
|  | description: Get started building your docs site with Starlight. | ||||||
|  | template: splash | ||||||
|  | hero: | ||||||
|  |   tagline: Congrats on setting up a new Starlight project! | ||||||
|  |   image: | ||||||
|  |     file: ../../assets/houston.webp | ||||||
|  |   actions: | ||||||
|  |     - text: Example Guide | ||||||
|  |       link: /guides/example/ | ||||||
|  |       icon: right-arrow | ||||||
|  |       variant: primary | ||||||
|  |     - text: Read the Starlight docs | ||||||
|  |       link: https://starlight.astro.build | ||||||
|  |       icon: external | ||||||
|  | --- | ||||||
|  |  | ||||||
|  | import { Card, CardGrid } from '@astrojs/starlight/components'; | ||||||
|  |  | ||||||
|  | ## Next steps | ||||||
|  |  | ||||||
|  | <CardGrid stagger> | ||||||
|  | 	<Card title="Update content" icon="pencil"> | ||||||
|  | 		Edit `src/content/docs/index.mdx` to see this page change. | ||||||
|  | 	</Card> | ||||||
|  | 	<Card title="Add new content" icon="add-document"> | ||||||
|  | 		Add Markdown or MDX files to `src/content/docs` to create new pages. | ||||||
|  | 	</Card> | ||||||
|  | 	<Card title="Configure your site" icon="setting"> | ||||||
|  | 		Edit your `sidebar` and other config in `astro.config.mjs`. | ||||||
|  | 	</Card> | ||||||
|  | 	<Card title="Read the docs" icon="open-book"> | ||||||
|  | 		Learn more in [the Starlight Docs](https://starlight.astro.build/). | ||||||
|  | 	</Card> | ||||||
|  | </CardGrid> | ||||||
							
								
								
									
										11
									
								
								docs_projectinca/src/content/docs/reference/example.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										11
									
								
								docs_projectinca/src/content/docs/reference/example.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,11 @@ | |||||||
|  | --- | ||||||
|  | title: Example Reference | ||||||
|  | description: A reference page in my new Starlight docs site. | ||||||
|  | --- | ||||||
|  |  | ||||||
|  | Reference pages are ideal for outlining how things work in terse and clear terms. | ||||||
|  | Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting. | ||||||
|  |  | ||||||
|  | ## Further reading | ||||||
|  |  | ||||||
|  | - Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework | ||||||
							
								
								
									
										2
									
								
								docs_projectinca/src/env.d.ts
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										2
									
								
								docs_projectinca/src/env.d.ts
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,2 @@ | |||||||
|  | /// <reference path="../.astro/types.d.ts" /> | ||||||
|  | /// <reference types="astro/client" /> | ||||||
							
								
								
									
										3
									
								
								docs_projectinca/tsconfig.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										3
									
								
								docs_projectinca/tsconfig.json
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,3 @@ | |||||||
|  | { | ||||||
|  |   "extends": "astro/tsconfigs/strict" | ||||||
|  | } | ||||||
		Reference in New Issue
	
	Block a user