HARDOCS

Release notes v.0.1.0-alpha

Hardocs is an  app focused on easy documentation for non-code focused projects like hardware design.

To read more about the project go to hardocs.github.io.

 

Core features

• Open source.
• Multiplatform desktop app that produces html documents.
• Document editor that supports , code, tables, and math formulas.
• Image handling(from drag and drop to screen shots, and urls).
• Creation of several documents.
• Standalone html documents that can be opened in any browser. You can share hardocs documents easily and anyone can read them as long as they have a browser.
• Copy paste these documents in other rich text editors like emails and you will get the same formatting result.

 

Planned features for next release

• Metadata reader and editor
• Selection of metadata standards specified in JSON schemas
• Pandoc integration to import and export different document formats (pdfs, epubs, markdown, etc.)

 

Roadmap

• Local database listing users project
• Cloud database to collaborate and share your documents databases

Some considerations before getting started with hardocs

1. This documentation has been made with hardocs and demonstrates some of the things you can do with it.
2. Hardocs aims to facilitate documentation where images are important part of documents, this is what we called non-code projects, like hardware design projects.
3. Hardocs index document is an actual index.html designed to consider publishing use cases, you can change the title of the index document but the filename will remain the same in the file system.
4. You cannot just load or read html documents you have to create a hardocs project using the top bar menu.

 

Usage

Step 1: Creating a hardocs project

Go to the top menubar on the left and create a project, it just requires specifying a folder some name and some basic description. The name you give to the project is the actual name of the folder.