A realtime collaborative editor for MkDocs projects.
This project is still a work in progress and is not yet ready for production.
MkDocsEditor aims to provide an easy way for you to manage your existing MkDocs projects:
- Section management (folders)
- create sections
- rename sections
- move an entire section to another location
- delete a section and all the content inside it
- Document management (
*.mdfiles)- create documents
- rename documents
- edit documents in realtime
- Quick formatting toolbar
- Syntax highlighting
- Markdown preview
- see the result on your hosted website right away
- move a document
- move all resources that are referenced in it, if possible
- delete documents
- delete unused resources that are referenced in it
- Resource file management (any file that is not a markdown file really)
- upload resource files
- download linked resources
- open/share linked resources (if supported by another app on your device)
- delete resource files
- automatically replace any reference to this resource in a document with a "deleted" note
- Search
- Full Offline Cache
MkDocsEditor is built around the famous Differential Synchronization algorithm developed by Neil Fraser which allows you to edit a document simultaniously while someone else is also editing.
TODO: insert gif here
To use this app an instance of MkDocsEditor-Backend needs to run on the server where your MkDocs project source files are located. Have a look at the documentation on it's project site to learn more on how to do this.
Simply enter the server connection details in the settings of the app and voila your done! 😄
Building this project should be straight forward. Just check out the repo and let Android Studio handle the rest.
Since this project uses a Gradle version >= 4.6 and the Android Gradle Plugin only supports " configuration on demand" on lower versions you have to manually disable it in your IntelliJ/Android Studio project settings. See this page for more info: https://stackoverflow.com/a/49994951/1941623
The emulator host PC can be accessed from inside the emulator via IP 10.0.2.2.
GitHub is for social coding: if you want to write code, I encourage contributions through pull requests from forks of this repository. Create GitHub tickets for bugs and new features and comment on the ones that you are interested in.
AGPLv3+