https://github.com/stasm/itsjusttext

It's Just Text
https://github.com/stasm/itsjusttext

Last synced: about 2 months ago
JSON representation

It's Just Text

• Host: GitHub
• URL: https://github.com/stasm/itsjusttext
• Owner: stasm
• Created: 2015-07-09T14:17:02.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-07-10T08:04:56.000Z (over 9 years ago)
• Last Synced: 2024-10-16T18:18:51.951Z (3 months ago)
• Language: HTML
• Homepage: http://informationisart.com/itsjusttext/
• Size: 113 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# It's Just Text

What if there was a way to convey an idea over a long distance such

that anyone regardless of age, physical condition, available equipment

or bandwidth can access it?

Introducing: __It's Just Text__.  The lowest common denominator of the

communication on the Internet.



## Only 3 Rules To Go By

  - Content is what matters.  Use plain text with no formatting other

    than emphasis and headers which facilitate reading.

  - Wrapping and whitespace are part of your content: control them.

    Structure your ideas with whitespace.  Wrap at the 72nd character;

    it reads well, zooms well and fits multiple documents side-by-side.

  - Forgo all interaction.  Don't store state, don't use dynamic

    elements, don't listen to events.

## Getting Started

__It's Just Text__ is a manifesto.  You can literally upload a \*.txt

file to your server and you're good.

But what if you want to embed an image in your document?  Or make it

easier for the reader to refer to other hyperlinked documents?  It's

the World Wide Web after all!

I wrote a tiny JavaScript library which parses plain text files using

a minimal Markdown-like syntax and produces a valid HTML document:

[itsjusttext].  It's licensed under the MIT license.  You're welcome

to create your own variation which best serves your needs.

Put the following HTML at the top of your text file.  Edit the title

and make sure the file is served as HTML (usually by changing its

extension to \*.html).

    

    

    It's Just Text

That's it!  The JavaScript code is fast and extremely lean, weighing in

at just 0.5 KB.  It will mark up your content in a minimal way as

described in the next section.

## What's Included

  - Your content, exactly how you wrote it.

  - Three levels of headings: # hello

  - Emphasis: \_\_hi there\_\_,

  - Links with references: [howdy].

  - Images via the <img> element.

  - And any other HTML as well, actually.

See the source of this page for a complete example.

--

[@stas]

[itsjusttext]: https://github.com/stasm/itsjusttext

[@stas]: https://twitter.com/stas