MarkNotes is a single index.php page application for managing Markdown files.

• Project Home: https://github.com/zemian/marknotes
• Project Owner: Zemian Deng
• License: The MIT License (MIT)
• Release: Notes

If this is a live site, go to Admin to manage the files! (NOTE: This link will not work in GitHub project hosting for obviously reason: they don't support PHP!)

A live demo is available here.

And some screenshots are available here.

• Single file index.php application.
• Easy copy and deploy index.php to any web folder.
• Clean and simple UI style with Markdown editing syntax highlight.
• Display all Markdown files with readme.md as default page.
• Support sub folders browsing up to 3 levels. Ignore all dot hidden folders.
• Web based Admin interface to manage Markdown files.
• Secure - Serve files from single directory only.
• Secure - Support Admin password.
• Configurable - Using optional .marknotes.json file.

Copy the index.php file to a live web server's public folder. And that's it!

Or to try it locally in your system. Install PHP and then run the following:

git clone https://github.com/zemian/marknotes
cd marknotes

php -S localhost:3000
open https://localhost:3000

By default the web server will serve the project directory for all *.md files, and you can click on any file links listed to on menu to view them. Change the browser URL with index.php?admin to go into Admin page. In there you can manage all the Markdown files.

The application supports the following config parameters that you may override using a .marknotes.json file located where the index.php is. Or you may also specified config file using a server ENV variable named MARKNOTES_CONFIG.

The Json file should contain a Json object. Below are the default values if you omit them.

{
    "root_dir": "",
    "title": "Mark Notes",
    "admin_password": "",
    "root_menu_label": "Notes",
    "max_menu_levels": 2,
    "default_dir_name": "",
    "default_file_name": "readme.md",
    "file_extension_list": [".md"],
    "exclude_file_list": [],
    "pretty_file_to_label": false
}

• "root_dir": Directory where to read Markdown files. Empty means relative to where index.php is.
• "title": Use to display the HTML title and Admin logo text.
• "admin_password": Set to non empty to required password to enter into admin area.
• "root_menu_label": Set a value to be displayed as root menu label.
• "max_menu_levels": Max number of depth level to list for menu links (sub-folders).
• "default_dir_name": Specify the root dir for note files. Empty means relative to where index.php is.
• "default_file_name": Default page to load in a notes dir.
• "file_extension_list": Content file extensions allowed to be manage.
• "exclude_file_list": List of file or directory to exclude relative from root_dir. If set, these won't even display in the admin interface.
• "pretty_file_to_label": If set to true, it convert file/dir name to a pretty link label.

Below config parameters will have default values of NULL if omitted.

• "menu_links": Manually set a menu links. Omit this entry and the menu links will be auto generated based on dirs/files listing.

    "menu_links": {
      "menu_label": "Notes",
      "menu_name": "",
      "menu_order": 1,
      "links": [
        { "order": 1, "label" : "Home", "file": "readme.md" },
        { "order": 2, "label" : "Markdown Sample", "file": "sample.md" },
        { "order": 3, "label" : "Release Notes", "file": "release.md" },
        { "order": 4, "label" : "License", "file": "license.md" }
      ],
      "child_menu_links": []
    }
  

• "files_to_menu_links": Remap file or dir name in generated menu_links with better label or hide it completely. If hide attribute is set, then it only hide from menu link, but it will still shows in Admin interface.

    "files_to_menu_links": {
      "readme.md" : { "order": 0, "label" : "Home" },
      "sample.md" : { "order": 1, "label" : "Markdown Sample" },
      "release.md" : { "order":2, "label" : "Release Notes" },
      "license.md" : { "order": 3, "label" : "License" },
      "todo.md" : { "hide": true },
      "temp" : { "hide": true }
    }
  

The default Admin password is not set. You may set the password in admin_password config parameter to non-empty value and it will prompt for login.

• parsedown A PHP parser to render Markdown file.
• parsedown-extra Support Markdown extra features.

For styling we use Bulma CSS. It's access through unpkg.com CDN directly.

We also use CodeMirror to enhance Editor and syntax highlight.

• Looking for more CMS like features? Try FirePage
• Looking for a simple directory listing? Try PurpleIndex