Obsidian Setup for local webpage edits

Why Obsidian?

  • Obsidian does live rendering of markdown, so it is easier to do formatting while doing the homework
  • Obsidian brings the webpages to the local machine, so it is easier to save files, paste screenshots and move things around between folders.

What is Obsidian again?

Obsidian is a powerful, local-first note-taking and knowledge management app that uses interconnected Markdown files.

How to use Obsidian for HTGAA?

  1. Ensure your computer has git installed
  2. Ensure Obsidian is installed
  3. setup git global username and email
  4. clone webpages repository into a directory of your choice using git clone {your https URL} git clone location git clone location
  5. Navigate to the webpages directory
  6. Do a git pull command in the terminal just in case

git pull is a command that is used to sync the repository stored in the web with the folder that is locally stored

  1. If you are on a windows based system, it might be recommended to run the following command as well - git config --global core.autocrlf true . This solves issues with how UNIX based and windows based directories handle new lines differently

  2. Open Obsidian and select “Open folder as vault” obsidian opening|400 obsidian opening|400

  3. Navigate to the {your chosen root directory}\webpages\content directory and select that as vault folder

  4. et voila, you have live rendering of your markdown files. You can even navigate using the navigation bar on the left obsidian navbar|400 obsidian navbar|400

  5. One you’re done editting and playing around, you have to commit your changes

    1. Go back to the webpages directory.
    2. run git add .
    3. git commit -m "my new changes"
    4. git push

  6. The above push needs to be done every time you make changes to the content. As good practice, please do run a git pull every time you start making changes

    The first time you run git push, you will be redirected to the pages.htgaa site to provide authentication. You will probably have to select authorize application git push authoriztion git push authoriztion

DISCLAIMER - Do this at your own risk, any and all actions you take on your computer system is completely your own responsibilty. The above is simply a documentation of a series of steps I took to get obsidian up and running.

I am sure someone else has done this before, I am just bringing this up so that people who haven’t yet discovered that obsidian can be used to edit your webpages are made aware of the same. There are a lot of housekeeping and security related things I have not gone into above. Feel free to suggest if I have made any mistakes, left things out, or if you have ideas on how to make this better.