Hello Joplin community,
Could you detail the expectations of the refactoring and give a roadmap, please?
The following info will be nice to know:
- What is the current solution?
- Do we keep the existing solution or an alternative is possible?
- Solution can be a side project or must be part of the main repo? (imho we should take advantage of github.com/joplin).
- How are managed the
mdgenerated dynamically (eg plugins list)? Is it "pluggable" to an external solution without too much effort?
- Others good-to-know?
The current documentation (under Joplin - an open source note taking and to-do application with synchronisation capabilities) is mainly a giant README.md file and various smaller Markdown files under /readme. All this is then built into the HTML website by a script.
We would like to improve this by splitting the main readme into smaller sections, have a new menu that would reorganise the help into various topics, and of course the build script will need to be updated.
A good part of this project will be about researching how other projects organise their documentation, proposing a way that would work well for Joplin, and discussing your ideas with the mentors and users. This is still a technical project though since you will need to deal with TypeScript, Markdown, HTML and CSS (and any other technology that might help) to build the new documentation. source
- Grav cms
- Github Pages
- Hugo cms
Create a dedicated post with your proposal and link it here.
Keep this post for general discussion on the initiative.