Skip to content

The LatchD project is simply a documentation engine (not just blogging) that I needed to do some tutorials and custom things for a website. It's designed to show typography resembling epub or bookish material and stripped down for ease of use. It also supports import and export from different formats so documents can come from anything from mdoc…

Notifications You must be signed in to change notification settings

PlasmaTrout/latchd-content-engine

Repository files navigation

eStorieD_tree_1dy](https://waffle.io/PlasmaTrout/latchd-content-engine)

LatchD Documentation Engine

This document engine is a work in progress that's not quite ready for primetime. The goal is make a documentation system that helps me write better and more uniformly. The editor restricts massive creativity in order to provide better looks and tooling.

Screenshot 1 - Current State

Is displayed as:

Screenshot 2 - Current State

To normal readers or visitors.

Most documentation is created outside of the actual web site using the creation engines command line tools. They are currently in active development and are targeting monodoc (mdoc) xml format imports first. Here is sample of the import at the current snapshot release.

Screenshot 3 - Import From mdoc

Mission

The vision of LatchD has gone through several iterations over the last few years, but one thing remains a constant: Web typography is horrible. It's getting better, don't get me wrong, but it's still horrible. The LatchD engine attempts to deliver a minimal writing and editing experience by improving on the typography and workflow used to create documentation, blogs, technical books and novels in a web based format.

Developing

This project uses Apache Sling 7 as its framework. After starting Apache Sling navigate to the root of the project and run:

mvn -PautoInstallBundle install

To install the project. Once installed you should be able to see the following pages:

If you change the selectors to edit.html you can access the editable content:

Clicking on each paragraph of text or control is used to present its editable dialog, however most content is content editable.

If you want to upload a image temporarily to play around the URL

is where you want to go.

About

The LatchD project is simply a documentation engine (not just blogging) that I needed to do some tutorials and custom things for a website. It's designed to show typography resembling epub or bookish material and stripped down for ease of use. It also supports import and export from different formats so documents can come from anything from mdoc…

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published