mirror of
				https://git.sr.ht/~tsileo/microblog.pub
				synced 2025-06-05 21:59:23 +02:00 
			
		
		
		
	Improve docs
This commit is contained in:
		
							
								
								
									
										14
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										14
									
								
								README.md
									
									
									
									
									
								
							@@ -5,15 +5,13 @@ A self-hosted, single-user, ActivityPub powered microblog.
 | 
			
		||||
[](https://builds.sr.ht/~tsileo/microblog.pub?)
 | 
			
		||||
[](https://git.sr.ht/~tsileo/microblog.pub/tree/v2/item/LICENSE)
 | 
			
		||||
 | 
			
		||||
This branch is a complete rewrite of the original microblog.pub server.
 | 
			
		||||
Instances in the wild:
 | 
			
		||||
 | 
			
		||||
Check out the test instance here: [testing.microblog.pub](https://testing.microblog.pub/).
 | 
			
		||||
 - [microblog.pub](https://microblog.pub/) (follow to get updated about the project)
 | 
			
		||||
 - [hexa.ninja](https://hexa.ninja) (theme customization example)
 | 
			
		||||
 - [testing.microblog.pub](https://testing.microblog.pub/)
 | 
			
		||||
 | 
			
		||||
The original server became hard to debug, maintain and is not super easy to deploy (due to the dependecies like MongoDB).
 | 
			
		||||
 | 
			
		||||
This rewrite is built using "modern" Python 3.10, SQLite and does not need any external tasks queue service.
 | 
			
		||||
 | 
			
		||||
It is still in early development, this README will be updated when I get to deploy a personal instance in the wild.
 | 
			
		||||
There are still some rough edges, but the server is mostly functional.
 | 
			
		||||
 | 
			
		||||
## Features
 | 
			
		||||
 | 
			
		||||
@@ -22,7 +20,9 @@ It is still in early development, this README will be updated when I get to depl
 | 
			
		||||
    - Consume most of the content types available (notes, articles, videos, pictures...)
 | 
			
		||||
 - Exposes your ActivityPub profile as a minimalist microblog
 | 
			
		||||
    - Author notes in Markdown, with code highlighting support
 | 
			
		||||
    - Dedicated section for articles/blog posts (enabled when the first article is posted)
 | 
			
		||||
 - Lightweight
 | 
			
		||||
    - Uses SQLite, and no external dependencies except Python 3.10+
 | 
			
		||||
    - Can be deployed on small VPS
 | 
			
		||||
 - Privacy-aware
 | 
			
		||||
    - EXIF metadata (like GPS location) are stripped before storage
 | 
			
		||||
 
 | 
			
		||||
@@ -37,6 +37,19 @@ Whenever one of these config items is updated, an `Update` activity will be sent
 | 
			
		||||
 | 
			
		||||
You can add custom emoji in the `data/custom_emoji` directory and they will be picked automatically.
 | 
			
		||||
 | 
			
		||||
#### Custom CSS
 | 
			
		||||
 | 
			
		||||
The CSS is written with [SCSS](https://sass-lang.com/documentation/syntax).
 | 
			
		||||
 | 
			
		||||
You can override colors by editing `data/_theme.scss`:
 | 
			
		||||
 | 
			
		||||
```scss
 | 
			
		||||
$primary-color: #e14eea;                                                                            
 | 
			
		||||
$secondary-color: #32cd32;
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
See `app/scss/main.scss` to see what variables can be overidden.
 | 
			
		||||
 | 
			
		||||
## Public website
 | 
			
		||||
 | 
			
		||||
Public notes will be visible on the homepage.
 | 
			
		||||
 
 | 
			
		||||
@@ -27,7 +27,7 @@ def main() -> None:
 | 
			
		||||
    shutil.rmtree("docs/dist/static", ignore_errors=True)
 | 
			
		||||
    shutil.copytree("docs/static", "docs/dist/static")
 | 
			
		||||
 | 
			
		||||
    last_updated = now().isoformat()
 | 
			
		||||
    last_updated = now().replace(second=0, microsecond=0).isoformat()
 | 
			
		||||
 | 
			
		||||
    readme = Path("README.md")
 | 
			
		||||
    template.stream(
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user