HelloZeroNet / HelloZeroNet/ZeroNet
More documentation for site developers needed
- Dominant language
- JavaScript
- Stars
- 18.8k
- Forks
- 2.3k
- PR merge metrics
- No merged PRs in 30d
Description
I'm building a ZeroNet blogging platform from scratch using Backbone.js and JSON+Markdown data formats.
I'd like to see more documentation on the ZeroFrame file API and routing, among additions to the code examples provided.
Currently there are copy-pastes CoffeeScript examples available at the documentation page regarding `fileGet` (which I'm using succesfully to read JSON, Markdown and .html template files) and `fileWrite` (which I can't seem to get working properly).
I need to save blog post contents into Markdown files and the post meta (such as date, title, publish status and so on) into a general `posts.json` file. Currently the WebSocket connection is error closed when I'm trying to write a new Markdown file into a site subfolder. Do the files need to exist in the `files` construct of the `content.json` file in order allow `fileWrite` to work properly?
Routing is a bit of a mystery for me in the ZeroFrame API. There is code available in the ZeroBlog source, but I'd like to know how setting the site `iframe`'s URL hash could be propagated to the ZeroFrame and onto the main browser window's URL hash.
Could the documentation be beefed up a bit to include pure JS examples that are not copy-pasted out of context (e.g. containing unknown variables and such)?
All additional information would be awesome. :)
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.