Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (u-blog-nostr) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
µBlog
uBlog is a minimalist blog on nostr that allows anyone to easily create their own personal micro-blog.
👁️ View Demo
·
🐞 Report Bug
Table of Contents
About The Project
WIP
Built With
Getting Started
- Fork this repo
- Edit
ublog.config.js - Deploy on vercel
Configuration
The ublog.config.js file contains the configuration settings for this project
| Option | Description | Required/Optional |
|---|---|---|
title |
The title of your blog. | Required |
description |
A brief description of your blog. | Required |
favicon |
The URL of the favicon image for your blog. | Optional |
logo |
The URL of the logo image for your blog. | Optional |
npub |
Your own public key for your blog. | Required |
themes |
An array of built-in themes. Choose your favorite themes. | Required |
customThemes |
An array of custom themes. You can generate your own theme from here. | Required |
relays |
An array of relays. | Required |
Note:
- At least one value is required between
themesandcustomThemes.
Roadmap
- Implement settings page
- Implement write page
- Implement publish button
- Implement loading ui
- Implement lightning tips
- Implement tags
See the open issues for a full list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the GPL-3.0 License. See LICENSE.txt for more information.
Contact
Discord - https://discord.gg/Xb9B4Ny
Project Link: https://github.com/nodetec/ublog
