Giter Club home page Giter Club logo

uncolored's Introduction

Following @n457_media on Twitter is the best way to keep you updated on my projects, including (Un)colored !



(Un)colored logo

Next generation desktop rich content editor that saves documents with themes.
HTML & Markdown compatible. For Windows, OS X & Linux.

version 0.10.2 — Beta ~ (version 1.0 in 4 releases)

  • (Un)colored is an editor that allows the user to focus on the text & content types (titles, lists, etc.), then selects the document saving format.
  • If the selected format is HTML, the user can choose an export document theme which defines the appearance of the saved document, that can be viewed directly in a web browser.
  • If the selected format is Markdown, the document is saved as raw Markdown file, without theme.
  • A saved HTML / Markdown document can be re-imported in the editor and re-exported, with theme or not, endlessly.

Supported Platforms

(Un)colored is provided for 64-bit systems only, on OS X 10.9 and later, Windows 7 and later, Linux (Ubuntu 12.04 and later, Debian 8 and later).

📦 Features (for now)

  • Multiple document tabs management
  • Standard word processor inline tools (bold, italic, underline, strikethrough, add link to selection, superscript, subscript, clear format)
  • 6 levels title tools
  • Block tools (paragraph, quote, unordered & ordered list, image insertion via URL)
  • Web-oriented tools (YouTube / Vimeo / Dailymotion / Twitch video insertion via URL, or ANY embedded content (SoundCloud tracks, Facebook posts, ...))
  • Export to HTML documents with 4 themes (always more to come)
  • Export to Markdown documents
  • Table of Content visualization & navigation system
  • Always on Top window control button
  • Real-time emojis (from http://www.emoji-cheat-sheet.com/ for now)
  • Interface themes system (1 interface theme for now, but more to come)
  • More than 40 mouse & keyboard shortcuts
  • Basic search / replace system (needs improvements)
  • Document information display (number of paragraphs, words, etc.)
  • Minimalist interface that let you focus on what matters : the content
  • Update auto-check system (enable / disable in settings)
  • Built-in english quick guide (more languages to come)

🏁 Roadmap

Here is what is planed for future releases of (Un)colored. These lists can change at any time and tasks can be added, moved, modified or deleted for several reasons, including feasibility and performance impact.

This public repository contains released versions of (Un)colored and their source code, the latest development/test version of the (Un)colored source code is on a private repository.

If you want more details about what was done, see the Changelog.

version 0.11.0
  • New User Interface built with web frameworks
  • New code structure : Core code separated from User Interface code, as a standalone external module
version 0.12.0
  • Additional Incorporate image from clipboard tool
  • Additional Incorporate image from file tool
  • Additional document themes
  • Code highlighting in saved themed document (supported languages : CSS, JavaScript, Ruby, CoffeeScript, PHP, SQL, C#, Diff, JSON, Markdown, C++, HTML, XML, Java, Python)
  • Other potential issue fixes
version 0.13.0
  • Additional Insert Image from File tool
  • Additional table tools : insert table & add, remove, move row & column
  • GitHub Flavored Markdown documents import/export full support
  • Potential issue fixes
version 1.0.0
  • Additional Tweet tool : insert a tweet from Twitter in documents
  • Emojis insertion via the toolbar
  • Additional text tools : selection to lower / upper / title case
  • Multi-Language Support & French language implementation
  • Potential issue fixes
📄 Writing Time
  • Documentation about how to create a document theme
  • Documentation about how to create a UI theme
  • Proper code comments with links to 🇺🇸 English documentations

🔩 Technical Details

(Un)colored is made to be fast & fully compatible with WebKit web browser engine and V8 JavaScript engine (those implemented in Google Chrome). So the application is entirely written without any compatibility fallback code and allows using latest web technologies.

  • ES6 : Object Oriented & more beautiful than classic JavaScript.

For the complete list of used projects, see below the Related Projects section.

⚠️ Known Issues

  • [Major issue] GitHub Flavored Markdown documents import/export not fully supported (and missing tools for it).
  • [Major issue] When entering a local image relative path in the Image via URL tool field, the image in the exported document is not visible in-browser.

👥 Contribute

If you have any question about the project, noticed a performance issue or a bug, you can let me know by posting on the GitHub issues section. I will be glad to answer :octocat:

Before creating a new issue topic, be careful to check if your question/issue is not in the Known Issues section above or already in the GitHub issues section.

🔧 Technical Documentation (not ready yet)

To know how to create a document theme or a interface theme, how to launch the development version of (Un)colored, how to build it or how it's made, see the Full Documentation.

🎁 Donation

— Support (Un)colored —

(Un)colored is free and open source. Making applications like this takes time. If you like this app, please consider to donate to support my work 😉 If you don't know how much to give, 6 € is a reasonnable amount (will be automatically converted into your currency). Have a nice day !

📄 License

(Un)colored is released under the Apache License 2.0. More information on http://choosealicense.com/licenses/apache-2.0/

❤️ Related Projects

Thanks to creators and contributors of these open source projects that (Un)colored proudly uses :

Countable.jsDOMPurifyElectronelectron-builderemojify.jsfindAndReplaceDOMTextforeach.jsgetmdl-selectgithub-markdown-cssjsVideoUrlParserLightRange.jsmarkedMaterial Design LiteMousetrapMousetrap Global BindNode.jsNormalize.cssreqwestSortableto-markdownversions-comparewysiwyg.jsZenscroll

Proudly powered by Electron

Electron logo

uncolored's People

Contributors

n457 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.