Skip to content

Commit 3e06046

Browse files
thiagogqthiagogq
authored
Update README.md
1 parent f32fa60 commit 3e06046

1 file changed

Lines changed: 49 additions & 23 deletions

File tree

‎README.md‎

Lines changed: 49 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,46 @@
1+
<img height=50 src="https://raw.githubusercontent.com/LibreBlogOrg/LibreBlog-Resources/refs/heads/main/images/icon.svg" />
2+
13
# LibreBlog
24

3-
**LibreBlog** is a static site generator that works entirely in your browser (as a browser extension or web page). This means you don't need to create an account or install any software. Just start crafting your articles :black_nib: :scroll:
5+
**LibreBlog** is an in-browser static site generator that supports Markdown, RIS references, and image embedding to create content-rich blogs. There are different types of articles, each with its own features.
6+
<br><br><br>
7+
8+
![LaTeX](https://raw.githubusercontent.com/LibreBlogOrg/LibreBlog-Resources/refs/heads/main/screenshots/latex.avif)
9+
*A LaTeX article with a math formula, an image, and a footnote.*
10+
<br><br>
411

5-
It was created to help bloggers and journalists produce content without depending so heavily on cloud-based web development services. You can read more about our motivation [here](https://blog.libreblog.org/articles/motivation).
12+
![Analysis](https://raw.githubusercontent.com/LibreBlogOrg/LibreBlog-Resources/refs/heads/main/screenshots/analysis.avif)
13+
*The timeline and 'key elements' were generated from __relations__.*
14+
<br><br>
15+
16+
![References](https://raw.githubusercontent.com/LibreBlogOrg/LibreBlog-Resources/refs/heads/main/screenshots/references.avif)
17+
*References are imported from one or more RIS files.*
18+
<br><br>
619

7-
The main output of this software is a ZIP file (*public_html.zip*) containing the files and folders of your website. Hosting is not provided, so you will need to unzip and save these files somewhere to get your website online.
20+
![Editor](https://raw.githubusercontent.com/LibreBlogOrg/LibreBlog-Resources/refs/heads/main/screenshots/editor.avif)
21+
*Articles can be written using Markdown syntax and Twig code.*
22+
<br><br>
823

9-
Below is an overview of the features included in this project and those that are not.
24+
![Inserting images](https://raw.githubusercontent.com/LibreBlogOrg/LibreBlog-Resources/refs/heads/main/screenshots/inserting-images.avif)
25+
*Simple image picker.
26+
<br><br>
27+
28+
![Media library](https://raw.githubusercontent.com/LibreBlogOrg/LibreBlog-Resources/refs/heads/main/screenshots/media-library.avif)
29+
*Media library*
30+
<br><br>
31+
32+
## Motivation
33+
34+
LibreBlog was created to help bloggers and journalists produce content without depending so heavily on cloud-based web development services. You can read more about our motivation [here](https://blog.libreblog.org/articles/motivation).
35+
36+
The main output of this software is a ZIP file (*public_html.zip*) containing the files and folders of your website.
37+
38+
## Features
1039

1140
**Built-in**:
1241
* Content creation and editing tools
1342
* Basic search functionality (using JavaScript)
43+
* **LaTeX support** (in LaTeX articles)
1444
* Easy insertion of **references** in articles
1545
* Possibility of creating **relations** between articles to make them richer and provide more context
1646
* SEO optimization (Semantic HTML, Sitemap, Open Graph, Schema.org and Simple Dublin Core)
@@ -41,8 +71,6 @@ Below is an overview of the features included in this project and those that are
4171
* Editorial workflow
4272
* User management
4373

44-
In short, LibreBlog is a piece of software that runs inside your browser and does not offer features that require a server. It is therefore more suited for bloggers and independent journalists than for large news websites.
45-
4674
## Installation
4775

4876
The best way to use LibreBlog is to install it as a browser extension. That way, you can use it offline and you will not lose your content if our website goes down.
@@ -54,6 +82,21 @@ The best way to use LibreBlog is to install it as a browser extension. That way,
5482
3. In the previous step, the necessary scripts will be copied to the *dependencies* folder, so you can delete the *node_modules* folder.
5583
4. Load the unpacked extension ([See how](https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#load-unpacked)).
5684

85+
## How to easily test your website (and render LaTeX articles)
86+
87+
Because the preview window is sandboxed, LaTeX articles cannot be rendered in preview mode (We are using this project to render the LaTex content: <https://latex.js.org>).
88+
89+
If you want to quickly preview your LaTeX articles while working on them, I recommend downloading [OnionShare](https://onionshare.org/) and [Tor](https://www.torproject.org/download/).
90+
91+
**Steps**:
92+
93+
1. Generate public_html.zip and unzip it.
94+
2. Open OnionShare, choose Host a Website, and select the public_html folder.
95+
3. Check the option "Don't send default Content Security Policy header".
96+
4. Open your website in Tor.
97+
98+
Note: For links to work, keep *Remove ".html" from page URLs* unselected on the editor's Settings page.
99+
57100
## Limitations
58101

59102
Currently, there is only one theme and the possibility to customize the colors. So if you enjoy designing themes, please read this [article](https://blog.libreblog.org/articles/creating-a-new-theme) and consider making a theme available to the community :purple_heart:.
@@ -70,20 +113,3 @@ These other projects are also being used:
70113
* [Marked](https://github.com/markedjs/marked) - to convert Markdown content generated by users into HTML
71114
* [Ace](https://github.com/ajaxorg/ace) - text editor for both website content and templates
72115
* [JSZip](https://github.com/Stuk/jszip) - used only to generate the *public_html.zip*
73-
74-
## Screenshots
75-
76-
![Analysis](https://raw.githubusercontent.com/LibreBlogOrg/LibreBlog-Resources/refs/heads/main/screenshots/analysis.avif)
77-
*An example of how __relations__ can enrich articles. The timeline and 'key elements' were generated from relations.*
78-
79-
![References](https://raw.githubusercontent.com/LibreBlogOrg/LibreBlog-Resources/refs/heads/main/screenshots/references.avif)
80-
*References are imported from one or more RIS files.*
81-
82-
![Editor](https://raw.githubusercontent.com/LibreBlogOrg/LibreBlog-Resources/refs/heads/main/screenshots/editor.avif)
83-
*Articles can be written using Markdown syntax and Twig code.*
84-
85-
![Inserting images](https://raw.githubusercontent.com/LibreBlogOrg/LibreBlog-Resources/refs/heads/main/screenshots/inserting-images.avif)
86-
*Simple image picker. The __theme__ takes care of inserting versions of the image with the appropriate size.*
87-
88-
![Media library](https://raw.githubusercontent.com/LibreBlogOrg/LibreBlog-Resources/refs/heads/main/screenshots/media-library.avif)
89-
*Media library*

0 commit comments

Comments
 (0)