Perhaps it’s not built over Github Pages, so much as it’s built over Github itself. Search uses Github. Edit uses Github (if you want an online editor). Display parses Github Flavored Markdown, and is intended for Github Pages.
It’s a smart idea, and probably quite effective. Two problems for me: no note privacy, since Github Pages doesn’t have a great security story. It’s features are pretty tied to Github, though obviously can be recreated off of it.
Great project though!
Thanks for the kind words :-) I wrote Precis in few hours (in an unpolished form) to take notes for myself. Hence, it offloads as much work as possible to Github. It has no dependencies other than git and basic *nix commands and you can get started with it in few minutes. You can always choose a different and more elaborate tool later for rendering your notes as they are just plain Markdown files in a git repo.
There are a few workarounds possible for note privacy. You can use Jekyll Auth with Precis and host it on Heroku or a VPS. But you’ll need to setup some CI mechanism to generate the HTML pages as you’ll be getting rid of Github which does it otherwise.
Alternatively, you can use a custom domain name for your Precis setup and put it behind an authenticated Cloudflare domain.
To save other’s from reading the source and being very confused:
This is 3 shell scripts which together generate a homepage, tag and date index markdown files from the ‘note’ markdown files in the directory, and add them to git. It’s intended for use as a pre-commit hook. It relies on Github Pages running repositories through Jekyll to render HTML with layouts, and Github Pages’ hosting.
It’s cool, I dig the tool use, but I was expecting something more complicated, so got very very confused when checking out the repo ’:D
It’s minimal in design and minimal in implementation too :-) I wrote it to get started with writing notes as quickly as possible and not care about anything else.
Yeah absolutely. I hope it didn’t come off as dismissive; I didn’t actually realize GitHub Pages would autorender a folder of markdown files, which led to a lot of head scratching :D
Nice. I once made something similar: a static blog generator which uses Github Issues to write blog posts and Github Pages to publish them. You can see an example and introduction here. The tool and the manual are on Github.
Didn’t want to hijack. Just thought maybe you are interested since your project looks similar.
I quite liked this. Thinking about using it to build my own site (currently trying to use lektor, but I think it might be too complicated).
Just one question: Is there any way to preview the webpage it will generate?
Edit: Clarifying, can I add/edit files locally, preview the website that will be generated, and then push to github?
I understand that it’s not in the scope of your project to do that, but, is there a way? Have you tried it?
Since Precis is built over Github Pages which in turn is built over Jekyll, it is possible to preview it locally. Refer to this article about how to set it up.
I really like the look and feel of your app.
I’ve been trying to do a minimal client-side js note/blog app for my personal uses for some time, with the hopes of coming to a solution that looks and feels similar to yours. Guess I’ll have one less personal project to do. :)
Thanks, I’m glad you liked it :-)