forked from importantimport/urara
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'importantimport:main' into main
- Loading branch information
Showing
45 changed files
with
2,088 additions
and
727 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,5 +6,6 @@ src/routes/**/ | |
static/ | ||
build/ | ||
.vercel_build_output/ | ||
.netlify/ | ||
.env.local | ||
.env.**.local |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,4 +3,5 @@ static/** | |
build/** | ||
node_modules/** | ||
pnpm-lock.yaml | ||
.vercel_build_output/ | ||
.netlify/** | ||
.vercel_build_output/** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,74 +14,85 @@ | |
<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-demo.netlify.app">🚀 Demo</a> | ||
/ | ||
<a href="https://github.com/importantimport/urara/discussions">Discussions</a> | ||
<a href="https://urara-docs.netlify.app">📝 Documentation</a> | ||
/ | ||
<a href="https://github.com/importantimport/urara/discussions">💬 Discussions</a> | ||
</p> | ||
|
||
## 🎉 Try it now! | ||
## ✨ Try it now! | ||
|
||
### Local | ||
|
||
```bash | ||
npx degit importantimport/urara [blog-name] | ||
npx degit importantimport/urara [blog-name] && cd [blog-name] | ||
pnpm i # if u don't have pnpm installed, run: npx pnpm add -g pnpm | ||
``` | ||
|
||
### Remote | ||
|
||
[](https://github.com/importantimport/urara/generate) [](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fimportantimport%2Furara&env=URARA_SITE_URL&envDescription=Site%20URL.&envLink=https%3A%2F%2Fexample.com&project-name=urara-blog&repository-name=urara-blog) [](https://app.netlify.com/start/deploy?repository=https%3A%2F%2Fgithub.com%2Fimportantimport%2Furara#URARA_SITE_URL=https://example.com&CUSTOM_LOGO=https://github.com/importantimport/urara/raw/main/urara/assets/[email protected]) | ||
|
||
## ⚡️ Usage | ||
|
||
### Development | ||
## ⚡️ Usage | ||
|
||
This template recommends using [pnpm](https://pnpm.io) and [@antfu/ni](https://github.com/antfu/ni). start a development server: | ||
This template recommends using [@antfu/ni](https://github.com/antfu/ni). | ||
|
||
```bash | ||
# http://localhost:3000 | ||
nr dev | ||
pnpm i -g @antfu/ni | ||
``` | ||
|
||
or listen to different IP and port: | ||
### Developing | ||
|
||
```bash | ||
# http://0.0.0.0:3000 | ||
nr dev --host 0.0.0.0 | ||
Start a development server: | ||
|
||
# http://0.0.0.0:8080 | ||
nr dev --host 0.0.0.0 --port 8080 | ||
```bash | ||
# pnpm run dev | ||
nr dev | ||
``` | ||
|
||
### Build | ||
### Building | ||
|
||
Create a production version of ur blog: | ||
|
||
```bash | ||
# pnpm run build | ||
nr build | ||
``` | ||
|
||
or use the specified adapter: | ||
u can preview the built app with `nr preview`. | ||
|
||
```bash | ||
# Vercel | ||
VERCEL=true nr build | ||
### Documentation | ||
|
||
# Cloudflare Pages | ||
CF_PAGES=true nr build | ||
For full documentation, visit [urara-docs.netlify.app](https://urara-docs.netlify.app). | ||
|
||
# Netlify | ||
NETLIFY=true nr build | ||
``` | ||
### Give this project a star | ||
|
||
tyvm! ur ⭐ will give me more motivation to improve this project. | ||
|
||
## 📦️ Pre-packed | ||
|
||
### TailwindCSS & PostCSS Plugins | ||
|
||
- [daisyUI](https://github.com/saadeghi/daisyui) - Tailwind CSS Components | ||
- [@tailwindcss/typography](https://github.com/tailwindlabs/tailwindcss-typography) - Beautiful typographic defaults for HTML you don't control. | ||
- [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss) - A utility-first CSS framework for rapid UI development. | ||
- [PostCSS](https://github.com/postcss/postcss) - a tool for transforming CSS with JavaScript | ||
- [PostCSS Preset Env](https://github.com/csstools/postcss-plugins/tree/main/plugin-packs/postcss-preset-env) - Convert modern CSS into something browsers understand | ||
- [PostCSS Import](https://github.com/postcss/postcss-import) - PostCSS plugin to inline @import rules content | ||
- [CSSNANO](https://github.com/cssnano/cssnano) - A modular minifier, built on top of the PostCSS ecosystem. | ||
|
||
> This template uses `@sveltejs/adapter-auto@next` and `@sveltejs/adapter-static@next` by default. | ||
### Markdown preprocessor & Syntax highlighter | ||
|
||
> when the environment supported by adapter-auto is not detected, it will automatically fallback to adapter-static. | ||
- [MDsveX](https://github.com/pngwn/MDsveX) - A markdown preprocessor for Svelte. | ||
- [Shiki Twoslash](https://github.com/shikijs/twoslash) - A beautiful Syntax Highlighter. | ||
|
||
> u can modify it to any adapter supported by SvelteKit. see [SvelteKit Docs](https://kit.svelte.dev/docs#adapters) | ||
### Vite Plugins | ||
|
||
> u can preview the built app with `nr preview`, regardless of | ||
> whether u installed an adapter. This should _not_ be used to serve | ||
> ur app in production. | ||
- [Unplugin Icons](https://github.com/antfu/unplugin-icons) - Access thousands of icons as components on-demand universally. | ||
|
||
## ✨ Sites | ||
## 🚀 Sites | ||
|
||
- [./kwaa.dev](https://kwaa.dev) | ||
|
||
|
@@ -96,7 +107,7 @@ are u using Urara? add the `urara-blog` topic on ur repo! | |
|
||
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. | ||
as published by Sam Hocevar. See the [COPYING](https://github.com/importantimport/urara/blob/main/COPYING) file for more details. | ||
|
||
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fimportantimport%2Furara?ref=badge_large) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.