Skip to content

init-zhang/zhangs-web-journal

Repository files navigation

Zhang's Web Journal

Real creative name, I know. This is my own journal and note taking application that runs on Flask and can be accessed using localhost.

It uses Markdown files internally, so everything is human readable with any editor and can be easily exported to HTML.

So far it has been basic features, such as:

  • Basic markdown support
  • Table of contents
  • Year and month views
  • Title and description metadata

I've been using this app for a few months now and have been adding features as I deemed fit. You're free to fork this project and tailor it to your own needs.

You can find the source code here. It also contains TODO for the project.

Installation and Usage

You will need Python as well as pip and venv.

The setup script supports Linux and should also support MacOS. Just run it (./setup.sh) and it should setup up everything for you.

It will:

  • create the virtual environment under .venv
  • install the requirement into the virtual environment
  • create the required user directories

run_server.sh is a simple script that runs the app using the python inside the virtual environment for you.

The app is hosted on localhost on port 8880. Just enter localhost:8880 into another web browser and the app should load.

TODO

  • Tags
  • CSS revamp
  • Folder support for notes
  • API upgrade

About

Personal markdown journal and note taking app

Resources

License

Stars

Watchers

Forks