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
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.
- 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...
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.
You can find it at GitHub or download it directly from Kode's server.
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.
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.
You need to change the parameters in Neon. All will be found in "js / config.js"
GitHub Page offical document here.
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.
That all. You can see Neon works well.
- 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.
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.
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:
Your contribution will be greatly appreciated and help us continue to develop Neon.