8000 GitHub - vorniches/tapnote: Instant, self-hosted publishing with Markdown.
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

vorniches/tapnote

Repository files navigation

TapNote

TapNote is a minimalist, self-hosted publishing platform inspired by Telegra.ph, focusing on instant Markdown-based content creation. It provides a distraction-free writing experience with instant publishing capabilities, making it perfect for quick notes, blog posts, or documentation sharing.

Check out the report on creating TapNote on dev.to or YouTube.

Demo

Live Demo

Features

  • Minimalist Writing Experience

    • Clean, distraction-free Markdown editor
    • No account required
    • Instant publishing with a single click
    • Support for full Markdown syntax
    • Self-hosted: maintain full control over your content
  • Content Management

    • Unique URL for each post
    • Edit functionality with secure tokens
    • Proper rendering of all Markdown elements
    • Support for images and code snippets

Quick Start

  1. Clone the repository:
git clone https://github.com/vorniches/tapnote.git
cd tapnote
  1. Start the application using Docker:
chmod +x setup.sh
./setup.sh
  1. Access TapNote at http://localhost:9009

Examples

# Heading 1
Some paragraph text here.

![Image](https://themepreview.home.blog/wp-content/uploads/2019/07/boat.jpg)

## Heading 2
Another paragraph of text with some **bold** text, *italic* text, and ~~strikethrough~~ text.

### Heading 3
1. An ordered list item
2. Another ordered list item

'```python
# Some Python code snippet
def greet(name):
    return f"Hello, {name}!"
```'

#### Heading 4
A quote block:
> This is a blockquote!

- Sub list item (unordered)
- Sub list item (unordered)

#### Table Example
| Column A | Column B |
|----------|----------|
| Cell 1A  | Cell 1B  |
| Cell 2A  | Cell 2B  |

https://youtu.be/vz91QpgUjFc?si=6nTE2LeukJprXiw1

Note: For correct rendering of code exmaple remove ' symbols.

Deploying

Deploy TapNote on a server in a few clicks and connect a custom domain with RailWay or your preferred service.

Contributing

Feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

License

MIT License

Acknowledgments

Support

  • Create an issue for bug reports or feature requests
  • Star the repository if you find it useful
  • Fork it to contribute or create your own version

About

Instant, self-hosted publishing with Markdown.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
0