How To Use Obsidian at the Littlefish Foundation

Introduction

Obsidian is a capable note-taking program and markdown file reader. The program's functionality enables you to quickly take notes and manage, edit, and publish them. Instead of keeping your records disorganized, you can use obsidian to build your own wiki. Obsidian is an excellent tool for assisting in the execution of your personal and organizational matters.

Why DAOs Should Use Obsidian

DAOs often need to publish lots of different documentation such as onboarding documents, whitepapers, and proposals. Obsidian is a great tool to publish documents and organize them however they want. Obsidian is a very powerful tool that has a learning curve but has very useful features and integrations. We in Littlefish use Obsidian to publish our whitepaper, projects, and documents and use GitHub to collaboratively work on Obsidian.

1. Markdown basics

Using a plain-text editor, markdown is a simple markup language for styling text. Might be confusing for people who haven't used it before. For this reason, we will share resources that will help beginners in this section.

Obsidian Markdown Cheat Sheet

The link below contains a list of all the markdowns that Obsidian supports.

https://www.markdownguide.org/tools/obsidian/

The page explaining the use of the markdown you need to utilize will open when you click on it.

It shows its usage in obsidian on the left and its html equivalent next to it.

The equivalent you will acquire on obsidian is given in the rendered output section.

For instance, suppose you type " # Heading," heading 1 style is used to format your content.

2. Obsidian Control Basics

Obsidian can be used more efficiently in certain key combinations, just as many other tools. You can access key combinations for Obsidian with the link we shared below.

https://keycombiner.com/collections/obsidian/

• From the right section, you can access the combinations according to your intended use.

3. GitHub + Obsidian Setup

In this section we will show you how to configure Obsidian and GitHub for Littlefish foundation.

First, go to the Littlefish foundation GitHub page with the link below.

https://github.com/littlefish-foundation/the-vault

Secondly, you will need to create your own fork. “ A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project."

Give your repository an unique name and click Create fork.

Now your cloned repository is ready to run your work.

• You can find more information about GitHub configuration on the GitHub for beginners page. In order for Obsidian and GitHub to work together, you need to complete the settings given on the GitHub for beginners page.

To setup Obsidian

First, we install the Obsidian with the link below.

https://obsidian.md/download

After that, all you have to do is clone the fork repository on your computer and introduce this file to Obsidian.

Select the path of your cloned repository.

Obsidian is ready to use.

4. Pushing and Requesting a Pull

We will show you two different methods for pushing your cloned repository.

• Obsidian GUI method ( user friendly )

• GitHub terminal method ( advanced user )

Obsidian GUI for Pushing

For example, we created a new file and wrote the necessary notes in it.

You can push it to your GitHub repository with the steps below.

• Press ctrl+p to open command tool and search for Open source control view.

• Add a suitable title next to the date part, press the stage all button then press commit button.

• Now your document is ready to push. Now all you need to do is press the push button

GitHub terminal method

You do not have to push the changes you have made with Obsidian, you can also push the changes you have made on Obsidian with the traditional way of adding a file to a repository using the command line.

1. Change directory to your cloned repository.

2. Stage the file with the below command

$ git add .

1. commit the file you have staged in your local repository

$ git commit -m "TEST PUSH"

1. Push the changes to GitHub

$ git push

If you have done the previous steps successfully, the last change you made will appear at the top of your fork page.

5. How to Request a Pull ?

To create a pull request, first move to your fork and click the Pull request button from the menu.

Then click create a pull request

Add a title and comment to your request and click Create pull request.

Your pull request and the commits you made on it will look like the following.

Last but not least, you can check other pull requests made on the main repository by other users, in the main repository Pull requests page.

**