Skip to content

basilean/stw

Repository files navigation

Spread the Word

Logo

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 text file. Internally, it uses marked with two custom extension to render and a couple of adwaita icons. Optionally, it will use highlight and/or mermaid. Thank you all projects!!!

Published View (reader)

This same site seen as published: Spread the Word

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.

Repository View (writer)

This same site seen from the GitHub repository view: Github Repository

Using a free service as GitHub 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 UI Layout HTML (Needs some changes to reflect your site.).
  • stw.css UI Style CSS (Easily customizable by anyone).
  • 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.