Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions .gitignore
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
4 changes: 4 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"recommendations": ["astro-build.astro-vscode"],
"unwantedRecommendations": []
}
11 changes: 11 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "./node_modules/.bin/astro dev",
"name": "Development server",
"request": "launch",
"type": "node-terminal"
}
]
}
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,13 @@ Follow these steps in every new docs repository.
- [ ] Add DNS config in AWS Route 53
- [ ] Add custom domain in GitHub
- [ ] Enable "Enforce HTTPS"
- [ ] Create a pull request with README updates
- [ ] Create a pull request
- [ ] Update the title in the README
- [ ] Update the URL in the README
- [ ] Update `astro.config.mjs` with appropriate configuration
- [ ] Update `src/content/docs/index.mdx` with appropriate information
- [ ] Update `public/site.webmanifest` with appropriate information
- [ ] Add any initial content
- [ ] Remove the "New Project Checklist" from the README
- [ ] Merge the pull request
- [ ] Verify that deployment is successful
Expand Down
24 changes: 24 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// @ts-check
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';

// https://astro.build/config
export default defineConfig({
site: "https://replace-me.mrs-electronics.dev",
integrations: [
starlight({
plugins: [],
title: 'Docs Template',
social: [
{ icon: 'github', label: 'GitHub', href: 'https://github.com/mrs-electronics-inc' },
{ icon: 'gitlab', label: 'GitLab', href: 'https://gitlab.com/mrs-electronics' },
],
sidebar: [
{
label: "Getting Started",
autogenerate: { directory: "getting-started" },
},
],
}),
],
});
Loading