Awesome
<br /> <div align="center"> <a href="https://github.com/importantimport/urara"> <img src="https://github.com/importantimport/urara/raw/main/urara/hello-world/urara.webp" alt="urara" /></a> </div> <br /> <p align="center"> <a href="https://fff.js.org"><img src="https://img.shields.io/badge/%F0%9F%8C%9F%20F%20F%20F-1.2-yellow?style=flat" alt="fff" /></a> <img src="https://img.shields.io/github/languages/top/importantimport/urara?color=%23ff3e00" alt="Language" /> <a href="https://github.com/importantimport/urara/blob/main/COPYING"><img src="https://img.shields.io/github/license/importantimport/urara?color=%23fff" alt="License" /></a> <img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fimportantimport%2Furara.svg?type=shield" alt="FOSSA Status" /> </p> <p align="center"> <a href="https://urara-demo.netlify.app">π Demo</a> / <a href="https://urara-docs.netlify.app">π Documentation</a> / <a href="https://github.com/importantimport/urara/discussions">π¬ Discussions</a> </p> <p align="center"> <span>English</span> | <a href="https://github.com/importantimport/urara/blob/main/README.zh.md">ζ£ι«δΈζ</a> </p>π Try it now!
Local
npx degit importantimport/urara my-blog && cd my-blog # create a new project in my-blog
pnpm i # if u don't have pnpm installed, run: npm i -g pnpm
Remote
β‘οΈ Usage
Developing
Start a development server:
pnpm dev
Building
Create a production version of ur blog:
pnpm build
u can preview the built app with pnpm preview.
Documentation
For full documentation, visit urara-docs.netlify.app.
Give this project a star
tyvm! ur β will give me more motivation to improve this project.
β¨ Features
- Out of the box Atom feed (WebSub), Sitemap, PWA (Web app manifest & ServiceWorker) support.
- Present beautiful interface designs and animations with daisyUI, of course.
- Good IndieWeb Compatibility - Multi-kind posts with microformats2 markup content, Showcasing Webmentions via webmentions.io API.
- Don't worry about the article and image directories - just put them under a folder and they'll be copied automatically at build time.
- Comment Components: Webmentions, Giscus, Utterances... u can use more than one.
π¦οΈ Pre-packed
TailwindCSS & PostCSS Plugins
- daisyUI - The most popular, free and open-source Tailwind CSS component library.
- Tailwind CSS Typography - Beautiful typographic defaults for HTML you don't control.
- Autoprefixer - Parse CSS and add vendor prefixes to rules by Can I Use.
- CSSNANO - A modular minifier, built on top of the PostCSS ecosystem.
Markdown preprocessor & Syntax highlighter
- MDsveX - A markdown preprocessor for Svelte.
- Shiki Twoslash - A beautiful Syntax Highlighter.
Vite Plugins
π Sites
and more...
are u using Urara? add the urara-blog topic on ur repo!
π₯ Contributing
If u're interested in contributing to Urara, pls read contributing docs before submitting a pull request.
π License
This work is free, it comes without any warranty. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2, as published by Sam Hocevar. See the COPYING file for more details.
special thanks / inspired from:
- @michaeloliverx - Generate Posts List
- icon made by Kpouri