diff --git a/README.md b/README.md index 1630e58..4e38306 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,26 @@ # Mercury -Terminal-like blog theme built from [Astro](https://astro.build), still in early beta. - -Demo: https://icy-beach-00f5be01e.6.azurestaticapps.net/ +(WIP) Terminal-like blog theme built from [Astro](https://astro.build) > 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! -## 🌌 Features -- Minimal, terminal like -- Ship only necessary JavaScript -- Full text search based on `Fuse.js` -- Full text RSS -- Create Blogrolls via a yaml file -- Your status at Fediverse, now at your home -- Comments powered by multiple engines +## 🚀 Project Structure -## 🚀 Getting Started -clone the repo and install dependencies: +Inside of your Astro project, you'll see the following folders and files: -```bash -git clone https://git.gb0.dev/gb/mercury.git +```text +/ +├── public/ +│ └── favicon.svg +├── src/ +│ ├── layouts/ +│ │ └── Layout.astro +│ └── pages/ +│ └── index.astro +└── package.json ``` -```bash -cd mercury && pnpm install -``` -run the dev server: -```bash -pnpm run dev -``` -open [localhost:4321](http://localhost:4321) in your browser. - -## 🔧 Usage -All you need is editing the `astro.config.mjs`'s site & base. - -For further config, edit `src/config.ts` according to the comment. - -To start writing, put your markdown & mdx files to /src/content/posts folder. - -To create a page, put markdown files into /src/content/pages folder. - -Shortcode-like components is also available at /src/components/shortcodes folder. +To learn more about the folder structure of an Astro project, refer to [our guide on project structure](https://docs.astro.build/en/basics/project-structure/). ## 🧞 Commands @@ -57,7 +37,4 @@ All commands are run from the root of the project, from a terminal: ## 👀 Want to learn more? -See the post [🕊](). I hope you like it. 💜 - -## ⚖️ License -GNU Affero Public License 3.0 \ No newline at end of file +Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). diff --git a/src/components/shortcodes/Spoiler.astro b/src/components/shortcodes/Spoiler.astro index 319f3f6..7a7dcff 100644 --- a/src/components/shortcodes/Spoiler.astro +++ b/src/components/shortcodes/Spoiler.astro @@ -1,21 +1,11 @@ --- const { tip = '' } = Astro.props --- +{/* TODO: make it work in paragraph wrapped elements */}