npm i --save-dev prettier prettier-plugin-astro
add file .prettierignore with similar content as .gitignore
add file .editorconfig with content
# EditorConfig https://EditorConfig.org
# top-most EditorConfig file
root = true
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 2
max_line_length = 120
add this scripts to package.json:
"prettier:help": "npx prettier --help",
"prettier:check": "npx prettier --check .",
"prettier:listdifferent": "npx prettier --list-different .",
"prettier:write": "npx prettier --write .",
add file prettier.config.cjs with content
/** @type {import("prettier").Config} */
const config = {
plugins: ["prettier-plugin-astro"],
};
module.exports = config;
with this the use of
npm run prettier:check
show you a warn list of file with not correct format
based on .editorconfig settings
npm run prettier:write
write the corrected file
install husky
npm install husky --save-dev
npm pkg set scripts.prepare="husky install"
npm run prepare
Add a hook:
npx husky add .husky/pre-commit "npm run prettier:write" git add .husky/pre-commit
now try a commit:
git commit -m "Keep calm and commit"
# `npm run prettier:write` will run
following
https://docs.astro.build/en/guides/upgrade-to/v3/
npm install astro@latest
in package json change project Version to "version": "0.3.0"
npm install
Moved: astro check now requires an external package
npm run astro check
just press 'Y' and astro calls
npm install @astrojs/check typescript
test
npm run build
update preatc and rss
npm run build
npm install @astrojs/preact@latest
npm install @astrojs/rss@latest
test
npm run sync
npm run check
npm run build
npm run preview
add all astro default commands as shortcut commands in package.json:
"scripts": {
"astro": "astro",
"build": "astro build",
"check": "astro check",
"dev": "astro dev",
"docs": "astro docs",
"info": "astro info",
"preview": "astro preview",
"start": "astro dev",
"sync": "astro sync",
"telemetry": "astro telemetry"
},
npm create astro@latest -- --template minimal
🧑🚀 Seasoned astronaut? Delete this file. Have fun!
Inside of your Astro project, you'll see the following folders and files:
/
├── public/
├── src/
│ └── pages/
│ └── index.astro
└── package.json
Astro looks for .astro
or .md
files in the src/pages/
directory. Each page is exposed as a route based on its file name.
There's nothing special about src/components/
, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Any static assets, like images, can be placed in the public/
directory.
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:3000 |
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 |
Feel free to check our documentation or jump into our Discord server.
current status
newest on top
addon: https://docs.astro.build/en/guides/content-collections/#migrating-from-file-based-routing
finished on
https://docs.astro.build/en/tutorial/6-islands/3/
https://docs.astro.build/en/tutorial/6-islands/1/
remark: rrs Feed is base URL + /rss.xml
use / control with https://www.inoreader.com
https://docs.astro.build/en/tutorial/5-astro-api/4/
https://docs.astro.build/en/tutorial/5-astro-api/
https://docs.astro.build/en/tutorial/4-layouts/3/
https://docs.astro.build/en/tutorial/4-layouts/