Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/changelogsite/changelog
Jekyll powered static site to host your product's changelog. Demo -
https://github.com/changelogsite/changelog
changelog jekyll jekyll-site netlify-cms
Last synced: 2 months ago
JSON representation
Jekyll powered static site to host your product's changelog. Demo -
- Host: GitHub
- URL: https://github.com/changelogsite/changelog
- Owner: changelogsite
- License: mit
- Created: 2019-05-02T10:25:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-10-06T05:10:20.000Z (about 2 years ago)
- Last Synced: 2024-09-29T02:42:11.022Z (3 months ago)
- Topics: changelog, jekyll, jekyll-site, netlify-cms
- Language: HTML
- Homepage: https://updates.changelog.site/
- Size: 39.1 KB
- Stars: 88
- Watchers: 7
- Forks: 28
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Changelog
Create a Changelog site of your Product
[Demo](https://updates.changelog.site)
[Setup Guide](https://medium.com/@bansal.io/how-to-host-your-product-changelog-4a7c8a44ed68)
## Quick Setup
1. Fork the project [Changelog](https://github.com/changelogsite/changelog)
2. Edit `_config.yml` with your data (check settings section)
3. Connect to the domain with Netlify.
## Publish Post
1. Create new file under `_posts` folder
2. File Name should be like yyyy-mm-dd-feature-name.md (See [This](https://github.com/changelogsite/changelog/blob/master/_posts/2019-04-30-welcome-to-changelog.md) file for referance )
3. Add the post content like this:
```
---
title: "Welcome to Changelog"
category: New
---
We have just launched this website. You will see our product's future updates here.
1. Subscribe our email.
2. Watch on Github (If you are developer)
3. Subscribe our [RSS feed](/feed.xml).
```
4. Commit new file.
## Features
- **Disqus Comment:**
What users think about the new feature? Let theme Discuss in the comment
- **Custom Domain:**
Don't compromise with your brand identity. Use your branded domain or subdomain.
- **Watch on Github:**
Developers can watch your changelog directly in their Github account.
- **RSS Feed:**
Let your user get new features in their favorite feed reader.
- **Google Analytics:**
Add Google Analytics with gtag.js
- **Markdown Support:**
It's easy to write change log in markdown.
- **Add Team Members:**
Host on Github and Invite team members if you want.
- **SSL Support:**
We recommend using Netlify to server your changelog. Netlify takes care of SSL.
- **Hosted on Github:**
Our Repository is hosted on Github. Just fork it.
- **Admin:**
Netlify CMS Powered Admin to release new features.
---
If you face any issue in the setup. Email me at [email protected] and I will help you to setup.
---
## Are you releasing a major version?
Launch at [BetaPage](https://betapage.co)
---
## Questions?
[Open an Issue](https://github.com/changelogsite/changelog/issues/new)
---
Contact me for sponsorship [email protected]
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details