Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glitchboyl/nameless
A Blog-System based on Git:octocat:ub Issues. Simple and Grace.
https://github.com/glitchboyl/nameless
Last synced: 10 days ago
JSON representation
A Blog-System based on Git:octocat:ub Issues. Simple and Grace.
- Host: GitHub
- URL: https://github.com/glitchboyl/nameless
- Owner: glitchboyl
- License: mit
- Created: 2018-07-19T07:22:17.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-03T01:20:58.000Z (9 months ago)
- Last Synced: 2024-10-07T13:40:39.598Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 1.21 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
English | [中文文档](https://github.com/LonelyLiaR/blog/issues/1)
# Nameless
Nameless is a Blog-System based on **React** and **GitHub Issues**. Simple and Grace. :wind_chime:
[Priview](https://nghtmre.surge.sh/)
## Features
- Hyper succinct style.
- All posts are based GitHub Issues, support Markdown, WYSIWYG.
- You can manage posts in Issues directly, easy and low cost. (But you cant delete post, can just hidden post. (Close issues))
- Commenting system. (Upcoming)
## Getting Started
First create a new GitHub repo. Assume that repo name is `blog`.
This repo Issues is where the posts are stored.
Of course you can also store the generated blog files here, so you can visit the blog by visit the repo's GitHub Page.
Then ~after star Nameless,~ run the following commands:
```shell
$ git clone https://github.com/LonelyLiaR/nameless
$ cd nameless
$ npm install
# or you can use Yarn.
$ yarn
```
Then open the configs file `src/custom-configs.json`.
```json
{
"BLOG_TITLE": "This is Blog's title",
"USERNAME": "Enter your GitHub USERNAME in this place",
"REPO": "Enter the posts store repo name, default USERNAME.github.io"
}
```
And you can customize some optional configs:
```
{
"AVATAR": "Customize display avatar's link",
"NICKNAME": "Customize display nickname",
"BIO": "Customize display bio",
"ARCHIVES_TITLE": "ArchivesPage's entry name",
"LABELS_TITLE": "LabelsPage's entry name",
"SOCIALS_LIST": { // Those will be displayed in your HomePage.
"SocialName": "url"
//... may set more than one.
},
"DATE_FORMAT": "Customize display date format",
"EMPTY_MESSAGE": "Customize display EmptyPage hints message",
"ERROR_TITLE": "Customize display ErrorPage title",
"ERROR_MESSAGE": "Customize display ErrorPage hints message",
"ERROR_NAV": "Customize display ErrorPage back HomePage's nav name"
}
```
Run start after modify the configs：
```shell
$ npm start
# or
$ yarn start
```
And you can visit the blog in `http://localhost:3000/#/`.
## Scripts
- `npm run build` or `yarn build` Generate blog files, the `build` folder's contents is the deploy website.
- `git pull` Update Nameless. You need to regenerate blog files and redeploy it.
## Contributing
Welcome to:
- [Pull requests](https://github.com/LonelyLiaR/nameless/compare).
- [Open issues](https://github.com/LonelyLiaR/nameless/issues/new).
**Now please, enjoy the Nameless, and hope you like it.**