https://github.com/tiim/android-markdown-widget

Small widget app to display a markdown file on the home screen
https://github.com/tiim/android-markdown-widget

Last synced: about 1 year ago
JSON representation

Small widget app to display a markdown file on the home screen

• Host: GitHub
• URL: https://github.com/tiim/android-markdown-widget
• Owner: Tiim
• License: gpl-3.0
• Created: 2022-03-27T14:22:22.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-26T14:26:16.000Z (almost 2 years ago)
• Last Synced: 2025-03-23T23:52:24.594Z (about 1 year ago)
• Language: Kotlin
• Size: 159 KB
• Stars: 105
• Watchers: 3
• Forks: 11
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Markdown Widget

Add a minimalistic widget with the content of a markdown file to your home screen.

This app is intended for users of [Obsidian](https://obsidian.md), but the widget will display any markdown file on your phone.

If you like this app, consider buying me a coffee.

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/Tiim)

## Where can I get this App

- Download the APK from the [Releases section](https://github.com/Tiim/Android-Markdown-Widget/releases/latest)

- Download from [F-Droid](https://f-droid.org/packages/ch.tiim.markdown_widget/)

## Features

* Open any markdown or text file on your phone and display it as an home screen widget.

* The widget is updated in a regular interval.

* Supports all standard markdown features and some extensions:

    * Task Lists

    * Markdown Tables

    * Strikethrough

    * WikiLinks

    * Frontmatter

Currently the widget is non-interactive. Tapping on links or scrolling the widget does not do anything.

## Planned Features

* LaTeX support

* [Admonitions / Callouts](https://help.obsidian.md/How+to/Use+callouts)

* Highlighting

## Development

### New Release:

- Update version and version code in [build.gradle](app/build.gradle).

- Commit file `git add . && git commit`

- Add tag `git tag vX.Y.Z`

- Push to github `git push && git push --tags`

## License

[GNU General Public License v3.0](https://github.com/Tiim/Android-Markdown-Widget/blob/main/LICENSE.md)