https://github.com/cyanxiao/nimblog
🏗 Build static blog with lines of HTML and Markdown.
https://github.com/cyanxiao/nimblog
html markdown reactjs static-site-generator web
Last synced: 11 months ago
JSON representation
🏗 Build static blog with lines of HTML and Markdown.
- Host: GitHub
- URL: https://github.com/cyanxiao/nimblog
- Owner: cyanxiao
- Created: 2022-05-16T05:52:20.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-08-06T11:08:59.000Z (almost 3 years ago)
- Last Synced: 2025-04-25T09:44:19.698Z (about 1 year ago)
- Topics: html, markdown, reactjs, static-site-generator, web
- Language: TypeScript
- Homepage: https://nimblog.vercel.app/
- Size: 322 KB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nimblog
  
Nimblog requires only a few lines of HTML to deploy and is suitable for lightweight bloggers. The [demo site](https://nimblog.vercel.app/) is built with Nimblog, check it out for more information.
* Runs on static website hosting platform, such as [GitHub Pages](https://pages.github.com/).
* Easy to customize themes, as you only need to bring in your own CSS files.
* Use [heti](https://github.com/sivan/heti) to optimize the layout.
I recommend the directory structure below.
```
index.html
your_essay_1.md
your_essay_2.md
your_pic_1.jpg
...
```
Then paste the following content in `index.html`.
```html
Nimblog
# [Your Blog](/)
- [your essay 1](your_essay_1.md)
- [your essay 2](your_essay_2.md)
```
As you can see, you can write Markdown directly in `` and link to your Markdown documents. Once you're done, just upload this directory to a static website hosting platform.
> **Note**
> Markdown in `` supports any kind of links but only ones ending with `.md` & `.txt` and with `text\markdown` content type are parsed as blog post links under the hood.
## 🔎 Live Preview
Copy & paste code below to edit online with [W3Schools Online Editor](https://www.w3schools.com/tryit/tryit.asp?filename=tryhtml_hello).
```html
Nimblog
# [Nimblog Intro](/)
- [How to Use](https://unpkg.com/nimblog/dist/production/how-to-use.md)
- [Contribution](https://unpkg.com/nimblog/dist/production/contribution.md)
```
> **Note**
> If you want to try it in other online editor like StackBlitz, make sure to turn off prettier or formatter so that Markdown content in HTML will not be destructed.
## 🧪 Contribution
Feel free to contribute to Nimblog.
Run `yarn` to install all dependencies.
Nimblog uses Parcel as the build tool. Run `yarn dev` to make live changes to the project. Run `yarn build` to build the production version.
Note that Parcel does not support invoking static assets natively, so static files are put in `\static` to make sure they can be accessed with HMR.