Skip to content

Commit

Permalink
Added astro docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zaxovaiko committed Oct 25, 2024
1 parent 2b680f2 commit ea84ea2
Show file tree
Hide file tree
Showing 42 changed files with 33,700 additions and 12,574 deletions.
42,829 changes: 30,255 additions & 12,574 deletions package-lock.json

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions packages/docs/.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 packages/docs/.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 packages/docs/.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"
}
]
}
49 changes: 49 additions & 0 deletions packages/docs/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
// @ts-check
import starlight from '@astrojs/starlight';
import { defineConfig } from 'astro/config';

// https://astro.build/config
export default defineConfig({
integrations: [
starlight({
title: 'uniforms',
social: {
github: 'https://github.com/vazco/uniforms',
},
sidebar: [
{
label: 'Introduction',
autogenerate: { directory: 'introduction' },
},
{
label: 'Getting started',
autogenerate: { directory: 'getting-started' },
},
{
label: 'API Reference',
autogenerate: { directory: 'api' },
},
{
label: 'Tutorials',
autogenerate: { directory: 'tutorials' },
},
{
label: 'Guides',
autogenerate: { directory: 'guides' },
},
{
label: 'Examples',
autogenerate: { directory: 'examples' },
},
{
label: 'Under the hood',
autogenerate: { directory: 'under-the-hood' },
},
{
label: 'Compare matrix',
autogenerate: { directory: 'compare-matrix' },
},
],
}),
],
});
32 changes: 32 additions & 0 deletions packages/docs/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"name": "docs",
"type": "module",
"version": "4.0.0-alpha.6",
"description": "Docs package of uniforms.",
"repository": "https://github.com/vazco/uniforms/tree/master/packages/uniforms",
"bugs": "https://github.com/vazco/uniforms/issues",
"funding": "https://github.com/vazco/uniforms?sponsor=1",
"keywords": [
"form",
"forms",
"meteor",
"react",
"react-component",
"schema",
"validation"
],
"scripts": {
"dev": "astro dev",
"start": "astro dev",
"build": "astro check && astro build",
"preview": "astro preview",
"astro": "astro"
},
"dependencies": {
"@astrojs/starlight": "~0.28.3",
"astro": "4.15.3",
"sharp": "0.32.5",
"@astrojs/check": "0.9.4",
"typescript": "5.6.3"
}
}
Binary file added packages/docs/public/favicon.ico
Binary file not shown.
8 changes: 8 additions & 0 deletions packages/docs/public/img/forminer.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/docs/public/img/hoc-hell.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions packages/docs/public/img/uniforms-graph.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/docs/public/img/uniforms-traits.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions packages/docs/public/img/uniforms.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions packages/docs/public/robots.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
User-agent: *
Allow: /
6 changes: 6 additions & 0 deletions packages/docs/src/content/config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import { defineCollection } from 'astro:content';
import { docsSchema } from '@astrojs/starlight/schema';

export const collections = {
docs: defineCollection({ schema: docsSchema() }),
};
Loading

0 comments on commit ea84ea2

Please sign in to comment.