technomancy-dev / technonomicon

The book of the devs.
https://technonomicon-red.vercel.app
26 stars 2 forks source link

Technonomicon: Summon the book.

  npm create astro@latest -- --template technomancy-dev/technonomicon
  cd ./technonomicon
  npm run dev

๐Ÿง™โ€โ™‚๏ธ Seasoned technomancer? Delete this file. Have fun!

just-the-basics

๐Ÿš€ Project Structure

Inside of your Book of the devs, you'll see the following folders and files:

โ”œโ”€โ”€ public/
โ”‚   โ””โ”€โ”€ favicon.svg
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ components/
โ”‚   โ”‚   โ”œโ”€โ”€ Cards/
โ”‚   โ”‚   โ”œโ”€โ”€ Content/
โ”‚   โ”‚   โ”œโ”€โ”€ Icons/
โ”‚   โ”‚   โ”œโ”€โ”€ ArticleTeaser.astro
โ”‚   โ”‚   โ”œโ”€โ”€ Empty.astro
โ”‚   โ”‚   โ”œโ”€โ”€ Markdown.astro
โ”‚   โ”‚   โ”œโ”€โ”€ More.astro
โ”‚   โ”‚   โ””โ”€โ”€ Navigation.astro
โ”‚   โ”œโ”€โ”€ layouts/
โ”‚   โ”‚   โ”œโ”€โ”€ Article.astro
โ”‚   โ”‚   โ””โ”€โ”€ Layout.astro
โ”‚   โ””โ”€โ”€ pages/
โ”‚       โ”œโ”€โ”€ articles/
โ”‚       โ”œโ”€โ”€ cards/
โ”‚       โ”œโ”€โ”€ issues/
โ”‚       โ””โ”€โ”€ index.astro
โ””โ”€โ”€ package.json

Astro (the magic which powers the technonomicon) 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. It has come pre-loaded with components to manipulate content, and create Cards.

It has come pre-loaded with components to manipulate content, and create Cards. Empty and More are simple components used to negate, or pass on particular MDX components when remixing content. Markdown takes a markdown source and components and renders them. ArticleTeaser.astro grabs just the teaser info from an article. Navigation.astro is a navigation (duh).

Any static assets, like images, 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?

Feel free to check our documentation