onepager 0.1

OnePager allows you to create simple and easy-to-navigate documentation for all your projects

:notebook: OnePager :notebook:

Welcome to the official repository for the OnePager library. OnePager is still under development and is therefore likely to undergo some minor changes over the next few months.

To install OnePager simply create a virtual environment (optional) and run pip install onepager.

Table of Contents :bookmark_tabs:

• What is OnePager?
• Why use OnePager?
• Why Pico.css?
• Create your first OnePager document
• Offline version
• Roadmap
• License

What is OnePager? :bulb:

OnePager allows you to generate simple and easy-to-navigate documentation for all your projects.

All you have to do is create a document and start writing some custom markdown syntax. Run onepager name_of_your_document.md and OnePager will automatically convert this document into a beautiful html page.

Special thanks to my workmate Evan who gave me the idea of starting this project.

Why use OnePager? :heart:

• Easy to deploy and use daily
• Mobile-friendly documents
• Cleaner and more visually appealing than traditional Word documents
• Easy bookmarking in browsers for centralized documentation
• Familiar Markdown syntax
• Colleagues can access documentation without editing capabilities (edits require modifying the corresponding Markdown file and running the Python script)

Why Pico.css? :two_hearts:

Pico.css is a fantastic CSS framework balancing ease of use with creative freedom. While less feature-rich than frameworks like Bulma, Pico offers a wide range of options with a lightweight footprint.

Like other minimal CSS frameworks, Pico handles many background styling tasks, freeing you to focus on content.

Create your first OnePager document :pencil:

For OnePager to work, follow these simple steps:

1. First line of your markdown file: This line should always adhere to the following structure:

[title],[owner 1],[owner 2 (optional)],[owner 3 (optional)],etc..

Example:

This is a document,Julien,Fiona

2. Collapsible sections: Each section starts with BEGIN,[section title] and ends with END.

Example:

BEGIN,This is a section about pizzas

Pizzas are **awesome**

END

3. Support for text highlighting: Simply wrap any term or sequence of terms you want highlighted around the ??! and !?? signs.

Example:

It seems that ??!this word!?? is very important.

Next simply paste the following code into a file named test.md:

This is a document,Julien,Fiona

Hi, I like junk food!

BEGIN,My fav type of food

Pizzas are ??!awesome!??

END

Now run the following command:

onepager test.md

This should create an html file named test.html that you can now open in your favourite browser.

Offline version :open_file_folder:

:warning: Currently, an internet connection is required for documents created with OnePager to render properly. :warning:

Coming soon! Support for offline documents is in development.

Roadmap :date:

• Offline mode support :construction_worker:
• Support for additional minimal CSS frameworks such as Milligram :construction_worker:

License :cop:

MIT