https://github.com/basilean/stw

Spread the Word
https://github.com/basilean/stw

content javascript md reader spa

Last synced: 1 day ago
JSON representation

Spread the Word

• Host: GitHub
• URL: https://github.com/basilean/stw
• Owner: basilean
• License: gpl-3.0
• Created: 2023-12-29T00:28:46.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-29T13:17:48.000Z (about 1 year ago)
• Last Synced: 2024-11-19T15:54:45.469Z (2 months ago)
• Topics: content, javascript, md, reader, spa
• Language: JavaScript
• Homepage: http://basile.ar/stw/
• Size: 34.2 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Spread the Word

![Logo](favicon-192x192.png)

> *Let the people share.*

This is multiple screen markdown reader in a single page application (SPA). It is written in Javascript to be portable, focused on being enjoyable by the reader and writer. It tries to acomplish this by giving the user many options to adjust its current display, while the creator  publish content easily with a [markdown](https://en.wikipedia.org/wiki/Markdown) text file. Internally, it uses [marked](https://marked.js.org) with two custom extension to render and a couple of [adwaita](https://gitlab.gnome.org/GNOME/adwaita-icon-theme) icons. Optionally, it will use [highlight](https://highlightjs.org) and/or [mermaid](https://mermaid.js.org). Thank you all projects!!!

## Published View (reader)

This same site seen as published: [Spread the Word](https://basile.ar/stw/)

Once there, you can experience with one of the many samples below. Remember to open the top left bar, set fullscreen, page width, font family, font size, background color and text color, they will give you oportunity to make the best of your current display. Settings are automatically saved.

* [books](example/books/README.md) Long pieces of text.  

* [comics](example/comics/README.md) A big strip of images.  

* [articles](docs/README.md) Combined text, images and code block.

    * [Using Spread the Word](docs/using_StW.md)

    * [Optionally Highlight](docs/using_highlight.md)

    * [Optionally Mermaid](docs/using_mermaid.md)

## Repository View (writer)

This same site seen from the GitHub repository view: [Github Repository](https://github.com/basilean/stw)

Using a free service as [GitHub](https://pages.github.com/) website, you just copy these 3 files in your own repository, customize them with your brand and style, then make README.md file home page. Style is barebones, imagine how pretty would you have your own site.  

Take a look to these 3 files:

* [index.html](index.html) UI Layout HTML (Needs some changes to reflect your site.).

* [stw.css](stw.css) UI Style CSS (Easily customizable by anyone).

* [stw.js](stw.js) Application Javascript (Easily extensible by a coder).

I use **README.md** for indexes, being Github repository browsing compatible, it is easy to edit online.