SveltePress-Native

Documentation for humans became native.

What is SveltePress Native?

SveltePress (at least on production) exports some internal maps into their own ES Modules (using jsesc) that it later imports for performance and technical reasons. Using these modules along with other exported functions (eg. the markdown to html converter function), you are able to "recreate" SveltePress using other libraries and tools. This project does that with GTK, QT & Flutter, targeting Linux, MacOS, Windows, Android and iOS!

Warning

The tooling is a bit more difficult to handle, especially for newcomers to those libraries. Each folder will include specific instructions, dependencies and requirements. Please read them carefully!

Keep in mind that each one of them has its advantages and disadvantages. Each readme contains a table with what's available and what has been tested.

Global info

Some info & assets are being used globally between all libraries.

Filename	Explaination	Note
./sveltepresslogo.png	logo that will be used as app icon	png, square
../sveltePress.config.js	the title is being used for the app name	anything non-latin or digit gets cleared

Installing

Using create-sveltepress-app:

# If you have SveltePress installed already
npx create-sveltepress-app add --gui

# If you don't have SveltePress installed you
# can include this by adding the `--gui` flag
# eg.
npx create-sveltepress-app create my-sveltepress-project --gui

Using degit:

# has to be done after installing SveltePress
# aka this is only for adding it
npx degit GeopJr/SveltePress/gui ./gui

Emojicode

Used in info tables.

{
    platform: {
        "🐧": "Linux",
        "🍎": "macOS",
        "🪟": "Windows",
        "🤖": "Android",
        "🍏": "iOS",
        "🌐": "Web"
    },
    review: {
        "✅": "Tested/Known that it's true",
        "😕": "Not Tested/IDK"
        "❌": "Failed test/Known that it doesn't work"
    }
}

Screenshots

GTK

QT

Flutter

Mobile

Desktop

Web

Contributing

1. Read the Code of Conduct
2. Fork it ( https://github.com/GeopJr/SveltePress/fork )
3. Create your feature branch (git checkout -b my-new-feature)
4. Commit your changes (git commit -am 'Add some feature')
5. Push to the branch (git push origin my-new-feature)
6. Create a new Pull Request