Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kodestudio/neon
Simple static site generator (not sure) for display the repository's (GitHub) events on a timeline.
https://github.com/kodestudio/neon
static-site-generator
Last synced: about 1 month ago
JSON representation
Simple static site generator (not sure) for display the repository's (GitHub) events on a timeline.
- Host: GitHub
- URL: https://github.com/kodestudio/neon
- Owner: kodestudio
- Created: 2020-08-15T07:29:49.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-08-23T13:27:12.000Z (over 4 years ago)
- Last Synced: 2024-08-01T21:59:03.007Z (4 months ago)
- Topics: static-site-generator
- Language: JavaScript
- Homepage: https://kodelang.dev/neon
- Size: 738 KB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- project-awesome - kodestudio/neon - Simple static site generator (not sure) for display the repository's (GitHub) events on a timeline. (JavaScript)
README
# Neon - static site generator (not sure)
Tools to display the repository's (GitHub) events on a timeline.
We don't know how to classify Neon.
The most basic definition of Neon: is a tool to help you create websites. That site displays the latest information and events for your repository and sorts it on a timeline.
Neon is develop in "dev" branch
## What is Neon?
Neon is a static website builder, used for open source projects on GitHub. Neon will display all the events that happen with the repo and are displayed in the timeline.
## What does Neon feature?
- Display events in timeline and directly synchronized with the repository on GitHub.
- Show infomation of your repository.
- Categorize events with that repository. Examples: a new commit, issues newly opened and closed, source code edit notifications, final release, beta, and preview.
- Displays information about the event creator in the repository.
- The events are listed in the form of lists, tags, cards and accompanied by interactive buttons.
- Directly create new events on Neon, and the events will be synchronized with the GitHub repository.
- Use Neon as a blog for your project.
- Create important notification for your repository.
- Easy to use.
- And more...
## Quick install Neon for your repository
Installing Neon is very simple. Neon is just a static website and you can install it anywhere. Here's how to install Neon into the repository through GitHub Page - because it is free.
### Step 1. Download the latest Neon release
You can find it at GitHub or download it directly from Kode's server.
### Step 2. Add Neon to your repository
#### Case 1:
In your repository, create a new directory called "docs" or "docs". Then copy all files in the release you downloaded. Make sure you have the correct path to the "index.html" file. For example, your-repo/docs/index.html.
#### Case 2:
Create new blank branch with following name "neon" and push all push all files in Neon. Make sure you have correct path to index.html at ROOT.
### Step 3. Config Neon
You need to change the parameters in Neon. All will be found in "js / config.js"
### Step 4. Enable Static Site in repository
GitHub Page offical document [here](https://pages.github.com/).
If at **Step 2** you do with *Case 1*: set the path for that Static Site to the "docs" folder.
Else you set the branch for GitHub Page to Neon.
### Step 5. Enjoy with Neon ;)
That all. You can see Neon works well.
## Task complete
- Create Neon repository in GitHub.
- Add Showdown library.
- Add Bootstrap.
- Write README.md for introduce about Neon.
- Complete GitHub.js (GetData).
- Added quick info of Repo (with button).
- Added more info of Repo.
- Added more key of config.
- Complete show notification.
- Design new UI with 3 zone.
## Library and resource we use to make Neon
- [Bootstrap](https://getbootstrap.com/) for design
- [Showndown](http://showdownjs.com/) is a library for convert MD to HTML
- [GitHub API]()
- [OAuth]()
- [JQuery]()
- [AJAX]()
## Neon is opensource
You can contribute to Neon in the following ways:
- Add a star on GitHub.
- Fork Neon.
- Watch Neon.
- Create new issues (report bugs/new idea/...).
- Share Neon to everyone.
## Donate
As you know, Neon is a free project and it will remain free. However, maintaining and improving Neon takes a lot of time and money.
So if you enjoy our work and find Neon helpful, please donate.
Donate for Neon at:
- [Ko-fi]()
- [Paypal]()
Your contribution will be greatly appreciated and help us continue to develop Neon.