update readme
Michael Kinder michael@foggymtndrifter.com
Sat, 11 Jan 2025 08:44:45 -0500
2 files changed,
40 insertions(+),
66 deletions(-)
A
README
@@ -0,0 +1,40 @@
+foggymtndrifter.com + +Technology Stack +This is a list of the various technologies used to build this website: + +Category: Technology Name +Framework: Astro +Styling: Tailwind +Components: shadcn/ui +Content: MDX +Syntax Highlighting: Shiki + rehype-pretty-code +Graphics: Penpot +Deployment: seelf + +Getting Started +Clone the repository: + git clone https://git.foggymtndrifter.com/FoggyMtnDrifter/website.git + cd website + +Install dependencies: + npm install + +Start the development server: + npm run dev + +Open your browser and visit http://localhost:1234 to get started. + +The following commands are also available: +Command: Description +npm run start: Alias for npm run dev +npm run build: Run type checking and build the project +npm run preview: Previews the built project +npm run astro: Run Astro CLI commands +npm run prettier: Blanket format all files using Prettier + +License +This project is open source and available under the MIT License. + +Built with ♥ by FoggyMtnDrifter, base theme by enscribe. +
D
README.md
@@ -1,66 +0,0 @@
-<div align="center"> - -## foggymtndrifter.com - -[![License]](LICENSE) - -</div> - ---- - -## Technology Stack - -This is a list of the various technologies used to build this website: - -| Category | Technology Name | -| ------------------- | -------------------------------------------------------------------------------------------------- | -| Framework | [Astro](https://astro.build/) | -| Styling | [Tailwind](https://tailwindcss.com) | -| Components | [shadcn/ui](https://ui.shadcn.com/) | -| Content | [MDX](https://mdxjs.com/) | -| Syntax Highlighting | [Shiki](https://github.com/shikijs/shiki) + [rehype-pretty-code](https://rehype-pretty.pages.dev/) | -| Graphics | [Penpot](https://penpot.app/) | -| Deployment | [seelf](https://yuukanoo.github.io/seelf/) | - ---- - -## Getting Started - -1. Clone the repository: - - ```bash - git clone https://git.foggymtndrifter.com/FoggyMtnDrifter/website.git - cd website - ``` - -2. Install dependencies: - - ```bash - npm install - ``` - -3. Start the development server: - - ```bash - npm run dev - ``` - -4. Open your browser and visit `http://localhost:1234` to get started. The following commands are also available: - - | Command | Description | - | ------------------ | --------------------------------------------------------------- | - | `npm run start` | Alias for `npm run dev` | - | `npm run build` | Run type checking and build the project | - | `npm run preview` | Previews the built project | - | `npm run astro` | Run Astro CLI commands | - | `npm run prettier` | Blanket format all files using [Prettier](https://prettier.io/) | - -## License - -This project is open source and available under the [MIT License](LICENSE). - ---- - -Built with ♥ by [FoggyMtnDrifter](https://foggymtndrifter.com), base theme by [enscribe](https://enscribe.dev/). - -[License]: https://img.shields.io/github/license/jktrn/astro-erudite?color=0a0a0a&logo=github&logoColor=fff&style=for-the-badge