👋 Welcome to MDN (MarkDown Note) Beta

This is a directory template for organizing your flavored markdown notes.

Store mdn direcotry into your preffered cloud drive and access from any envirnoment with your favoriate Integrated Development Envinorment or IDE!

---

🚀 Get started

1. Log in to your terminal

2. cd into your cloud drive directory

   i.e.

   * replace <username> with your user name

   For macOS

   - OneDrive
   $ cd /Users/<username>/OneDrive
   
   - Google Drive
   $ cd /Users/<username>/Google\ Drive
   
   - iCloud Drive
   $ cd /Users/<username>/Library/Mobile\ Documents/com\~apple\~CloudDocs

   For Windows

   - OneDrive
   C:\Users\<username>\OneDrive
   - Google Drive
   G:\'My Drive'
   - iCloud Drive
   C:\Users\<username>\iCloudDrive

3. Create mdn directory. This is your note library.

4. Add alias to your note library in the shell command settings

   For zsh (replace .zshrc with .bashrc for bash shells)

   $ echo 'alias mdn="cd /Users/<username>/OneDrive/mdn >> /Users/<username>/.zshrc

5. (Optional) Add note library to your private git repository

   You can also backup your Note Library to git repository of your choice.

   For Bitbuckt (Unlimited free private repositories)

   $ git init
   $ git add -A
   $ git commit -am "Initialized repository"
   $ git remote add <name> <url>

   See more details about Bitbucket and adding remote repository

   Of course, Github is also offering unlimited private repositories for FREE as well.

Now you have it!! 🍰🎉

You may start taking notes with markdown files, organize your notes with directories, backup your markdown note library on the cloud drive, and access to it from any where.

Templates

• Logs: Dump folder for log like brew upgrade for example.
• Notes: General notes folder. 🈂️ There is sample Syllabus for folks coming from my podcast here.
• Code Templates: Use this folder to organize your code snippets in one place. Once you create your beautiful templates here, you'll have consistant readability in your code or config files!
• Projects: Make lists or large csv files for your project and save here to make it reusable.

MarkDownNote on Github

https://github.com/meiokubo/mdn