Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lebcit/blog-doc
The simplest Node.js CMS and SSG!
https://github.com/lebcit/blog-doc
blog blog-engine blog-theme cms content-management-system eta hono markdown markdown-to-html marked ssg ssg-build ssg-theme static-site static-site-generator
Last synced: 14 days ago
JSON representation
The simplest Node.js CMS and SSG!
- Host: GitHub
- URL: https://github.com/lebcit/blog-doc
- Owner: LebCit
- License: mit
- Created: 2022-11-04T18:15:48.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-18T03:33:00.000Z (3 months ago)
- Last Synced: 2024-10-25T10:37:33.894Z (22 days ago)
- Topics: blog, blog-engine, blog-theme, cms, content-management-system, eta, hono, markdown, markdown-to-html, marked, ssg, ssg-build, ssg-theme, static-site, static-site-generator
- Language: JavaScript
- Homepage: https://blog-doc.pages.dev/
- Size: 3.63 MB
- Stars: 14
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Blog-Doc
The Simplest Node.js CMS & SSG!
A tiny flame in the darkness of error...
## Documentation
With the release of [version 3.0.0](https://github.com/LebCit/blog-doc/releases/tag/v3.0.0), Blog-Doc has undergone some fantastic updates. I've integrated [LiteNode](https://www.npmjs.com/package/litenode) to streamline and enhance your experience.
The Blog-Doc admin interface is now more intuitive than ever. Each page comes with its own handy documentation, all designed with [responsive attributes](https://responsive-attributes-generator.pages.dev/) for seamless usability on any device.
You can check out **the full documentation for Blog-Doc** here: [Blog-Doc Documentation](https://blog-doc.pages.dev/).
## Requirements
1. Blog-Doc requires [Node.js](https://nodejs.org/en) version 18.x or higher.
- For the best experience, use the latest [Long Term Support](https://nodejs.org/en/download/package-manager) (LTS) version.
2. Make sure you have the latest version of [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installed.
## Installation
To get Blog-Doc up and running on your machine, follow these steps:
1. Open your preferred IDE (like VS Code) and navigate to the directory where you want to install Blog-Doc.
2. In the terminal, you have two options to install Blog-Doc:
### Option 1: Using `npx`
Run the following command:
```bash
npx create-blog-doc my-blog-doc-app
```
This will create a new folder named **my-blog-doc-app** within your current directory, containing all the files you need.
### Option 2: Using `npm init`
Alternatively, you can use the following command:
```bash
npm init blog-doc my-blog-doc-app
```
This will also create a new folder named **my-blog-doc-app** within your current directory, containing all the files you need.
3. Once installed, start Blog-Doc by typing:
```bash
npm run fire
```
This command will launch the app, which you can then explore in your browser at [localhost on port 5000](http://localhost:5000).
Blog-Doc comes with some sample posts and pages. Feel free to create your own content through the admin interface, and you can remove the default ones as needed.
Enjoy exploring Blog-Doc! š
## What's Next?
Iām excited to keep improving Blog-Doc in my spare time. Consider it a prototype that you can customize and adapt to your own design and template needs.
I genuinely hope this tool is helpful for the Node.js and Markdown communities. I welcome any [ideas](https://github.com/LebCit/blog-doc/discussions/categories/ideas), [code issues](https://github.com/LebCit/blog-doc/issues), or [code improvements](https://github.com/LebCit/blog-doc/pulls) you might have.
See you around!
[LebCit](https://lebcit.github.io/)