ๅพ่ทฏ๐Ÿฌ็ ”็ฉถๆ‰€: File Structure

ๆœ€ๅŽๆ›ดๆ–ฐ: 2024ๅนด3ๆœˆ17ๆ—ฅ

่ฏทๆˆ‘ๅ–ๅ’–ๅ•ก

A one line summary of what each file and directory is for:

/
โ”œโ”€โ”€ public/ // Files publicly available to the browser
โ”‚   โ”œโ”€โ”€ fonts/ // The default fonts for ๅพ่ทฏ๐Ÿฌ็ ”็ฉถๆ‰€
โ”‚   โ”‚   โ””โ”€โ”€ atkinson-bold.woff  // default font weight 700
โ”‚   โ”‚   โ””โ”€โ”€ atkinson-regular.woff // default font weight 400
โ”‚   โ”œโ”€โ”€ js/ // Javascript that will be imported into <head>
โ”‚   โ”‚   โ””โ”€โ”€ animate.js // function for animating page elements
โ”‚   โ”‚   โ””โ”€โ”€ bg.js // function for generating the background
โ”‚   โ”‚   โ””โ”€โ”€ scroll.js // scroll handler for the header styles
โ”‚   โ”‚   โ””โ”€โ”€ theme.js // controls the light and dark theme
โ”‚   โ””โ”€โ”€ brand.svg //the icon that displays in header and footer
โ”‚   โ””โ”€โ”€ favicon.svg //the icon that displays in the browser
โ”‚   โ””โ”€โ”€ ui.svg // an svg sprite for all ui icons on the website
โ”‚   โ””โ”€โ”€ social.svg // an svg sprite for all social media icons
โ”‚   โ””โ”€โ”€ open-graph.jpg // the default image for open-graph
โ”‚   โ””โ”€โ”€ robots.txt // for web crawlers and bots to index the website
โ”œโ”€โ”€ src/ // Everything that will be built for the website
โ”‚   โ”œโ”€โ”€ components/ // All astro and SolidJs components
โ”‚   โ”œโ”€โ”€ content/ // Contains all static markdown to be compiled
โ”‚   โ”‚   |  blog/ // Contains all blog post markdown
โ”‚   โ”‚   |  projects/ // Contains all projects markdown
โ”‚   โ”‚   |  about_loi/ // Contains all about_loi page markdown
โ”‚   โ”‚   |  legal/ // Contains all legal docs markdown
โ”‚   โ”‚   โ””โ”€โ”€ config.ts // Contains the collection config for Astro
โ”‚   โ”œโ”€โ”€ layouts/ // Reused layouts across the website
โ”‚   โ””โ”€โ”€ pages/ // All of the pages on the website
โ”‚   โ””โ”€โ”€ styles/ // CSS and global tailwind styles
โ”‚   โ””โ”€โ”€ lib/ // Global helper functions
โ”‚   โ””โ”€โ”€ consts.ts // Page metadata, general configuration
โ”‚   โ””โ”€โ”€ types.ts // Types for consts.ts
โ””โ”€โ”€ .gitignore // Files and directories to be ignored by Git
โ””โ”€โ”€ .eslintignore // Files and directories to be ignored by ESLint
โ””โ”€โ”€ eslintrc.cjs // ESLint configuration
โ””โ”€โ”€ astro.config.mjs // Astro configuration
โ””โ”€โ”€ tailwind.config.mjs // Tailwind configuration
โ””โ”€โ”€ tsconfig.json // Typescript configuration
โ””โ”€โ”€ package.json // All the installed packages