Skip to content

OSV v0.1.0 Alpha

Latest
Latest

Choose a tag to compare

View all tags
@karsoncaliff karsoncaliff released this 25 Jan 18:07
· 1 commit to main since this release
v0.1.0-alpha
37c23c3

Obsidian Student Vault v0.1.0 - Alpha Release 🎉

🌟 Current Features

  • Automatic grade calculations:
Homepage_Classes
  • Organized file and directory with homepages and class dashboards:
English_Class_Overview
  • Both file and manual based assignment tracking:
Assignment_Task_Inline_Field_Reading_View
  • Assignment lists based on priority and due date:
Homepage_Assignments_Overview
  • Notes and Resources management and displays:
Homepage_Recent_Notes

And much more for you to discover!

🗺️ Roadmap

In Development

  • GPA Dashboard
  • Preformatted assignments and notes

Planned Features

  • Late/Upcoming assignment warnings
  • Calendar/timeline view
  • What-If calculator
  • Class archives
  • Grade trends visualization
  • Data saving/export

Future Ideas

  • Visual Studio Code support
  • Quick add keybinding

📥 Installation

First, create the folder which you'd like the vault to be stored in. Where you store your vaults is completely up to you. For example, I stored mine in: $HOME/Documents/Obsidian/School.

On linux, this would be done with:

mkdir -p $HOME/Documents/Obsidian/School

On windows, you can use your file manager to manually do this.

It is recommended that you store your vaults in the same parent directory, such as $HOME/Documents/Obsidian for me.

After you've created the folder you'd like to store your vault in, extract its contents into your folder, or manually clone the repository into the folder as such:

git clone "https://github.com/krisfinga/obsidian-student-vault" $HOME/Your/Vault/Directory
  1. Run setup script (optional but recommended):
   cd /path/to/extracted/folder
   chmod +x setup.sh
   ./setupl.sh

The setup script is currently not available for windows.

This will help you set up your classes automatically!
If you skip the install script, you'll need to manually create class files using templates. For information on how to do this, visit the Adding Classes section of the README.

  1. Open in Obsidian - Open the folder as a vault
  2. Trust plugins - When prompted, click "Trust author and enable plugins"
  3. You're ready! - Check out the Creating Assignments & Notes section of the README to get started!

📚 Documentation

See the full README.md for detailed configuration options.

🐛 Found a Bug?

Please open an issue - feedback is essential for improvement!

💬 Feedback?

This is an early alpha release. Your feedback helps make OSV better for everyone!

  • 🐛 Report bugs
  • 💡 Suggest features
  • ⭐ Star the repo if you find it useful!

Note: This is alpha software. Expect bugs and missing features. Always backup your vault!

Assets 3
Loading