Baseline Obsidian Theme

repository·main·Indexed 23 days ago

https://github.com/aaaaalexis/obsidian-baseline

A highly customizable Obsidian theme providing a refined foundation for personal knowledge management. It features deep integration with Style Settings, a community marketplace for presets, and a variety of layout helper classes for banners, block widths, card-based layouts for Dataview and lists, image filters, and extended checkbox syntax.

Tokens
1.9K
Snippets
1
Records
12
Agent score
31%

What's inside obsidian-baseline

  1. Upload preset files and screenshots to the repository

    main

    After forking the Baseline repository, you need to upload your assets to your fork.

    1. Upload the Preset File

    • Navigate to the docs/marketplace/preset/ folder in your fork.
    • Upload your .json preset file (e.g., new-preset.json).
    • Ensure the file is in valid JSON format.

    2. Upload Screenshots

    • Screenshots must be PNG files.
    • Requirement: Use a full window capture with no borders or shadows.
    • Naming Convention:
      • Default (both modes): [preset-id].png (e.g., new-preset.png)
      • Light mode only: [preset-id]@light.png (e.g., new-preset@light.png)
      • Dark mode only: [preset-id]@dark.png (e.g., new-preset@dark.png)
    • Upload these to the docs/marketplace/preset/ folder.
  2. Submit your preset for Marketplace review

    main

    Once you have uploaded your files and updated preset.json in your fork, you must submit a Pull Request to the main repository.

    1. Go to the main page of your forked repository on GitHub.
    2. Click the Contribute button, then click Open a pull request.
    3. Use the following naming convention for your Pull Request title: Add Preset: [Preset Name]
    4. Click Create pull request.
  3. Register a new preset in preset.json

    main

    To make your preset visible in the Marketplace, you must add a new entry to the docs/marketplace/preset.json file in your fork.

    1. Open docs/marketplace/preset.json and click the edit icon (✏️).
    2. Scroll to the bottom of the file.
    3. Add a comma , after the last closing curly brace }.
    4. Paste the following template and fill in your details:
    "unique-preset-id": {
      "name": "Preset Name",
      "author": "Name or Username",
      "url": "https://github.com/my-username",
      "description": "A short, engaging description of your preset's look and feel."
    }

    Field Definitions:

    • unique-preset-id: A unique identifier in kebab-case. Crucial: This must match your preset file name and image file name (excluding the extension).
    • name: The display name for your preset.
    • author: Your name or username for credit.
    • url: A link to your GitHub profile, website, or social media.
    • description: A short description. Supports Markdown link syntax [Text](URL).
  4. Export your Baseline Style Settings preset

    main

    To share your look, you must first package your current Obsidian settings into a JSON preset file using the Style Settings plugin.

    1. Open Settings in Obsidian.
    2. Navigate to the Style Settings plugin options.
    3. Find the Baseline section.
    4. Click the export icon (located beside the ↺ icon).
    5. Save the file using a descriptive, lowercase name with dashes (e.g., my-new-preset.json).
  5. Apply Image filters and grids

    main

    Apply filters to images by adding the filter name after a # at the end of the image link (e.g., ![[image.jpeg#invert]]).

    Image Filters:

    FilterDescription
    #blendBlend image into background
    #invertInvert images in dark mode
    #invertWInvert images in light mode
    #circleCrop image to a circle
    #outlineAdd outline around image
    #interfaceAdd drop shadow behind image

    Image Grids:

    ClassDescription
    img-gridActivate image grids
  6. Use Cards layout for Dataview and Lists

    main

    Baseline supports card-based layouts for Dataview tables and bullet lists.

    ClassDescription
    cards (required)Set all Dataview tables to card layout
    list-cardsSet all bullet lists to card layout
    cards-align-bottomAlign the last element of a card to the bottom
    cards-coverImages are resized to fill the defined space
    cards-16-9Fit images in cards to 16:9 ratio
    cards-1-1Fit images in cards to 1:1 ratio (square)
    cards-2-1Fit images in cards to 2:1 ratio
    cards-2-3Fit images in cards to 2:3 ratio
    cards-cols-1 to 8Force a specific number of columns (from 1 to 8)
  7. Configure Block width and layout

    main

    Use these classes to control the width and behavior of content blocks within a note.

    ClassDescription
    wideEntire note uses wide line width
    maxEntire note uses max line width
    table-100, bases-100, img-100Fill 100% of the pane width
    table-max, bases-max, img-maxFill the max line width (default 90%)
    table-wide, bases-wide, img-wideFill the wide line width
  8. Use Alternate Checkbox syntax

    main

    Baseline supports extended checkbox states using the following syntax in lists:

    SyntaxDescription
    - [ ]To-do
    - [/]Incomplete
    - [x]Done
    - [-]Canceled
    - [>]Forwarded
    - [<]Scheduling
    - [?]Question
    - [!]Important
    - [*]Star
    - ["]Quote
    - [l]Location
    - [b]Bookmark
    - [i]Information
    - [S]Savings
    - [I]Idea
    - [p]Pros
    - [c]Cons
    - [f]Fire
    - [k]Key
    - [w]Win
    - [u]Up
    - [d]Down
    - [+]Add
    - [B]Brainstorm
    - [a]Alarm
    - [n]Note
    - [R]Review
    - [t]Time
    - [P]Phone
    - [L]Love
  9. Use Banner classes in notes

    main

    Baseline provides classes to enhance note headers using images and callouts.

    ClassDescription
    bannerAdd at the end of the image link, e.g. ![[image.jpeg|banner]]
    banner-fadeAdd faded edge to the banner (requires banner)
    banner-iconAdd an emoji or letter as note icon using callout, e.g. > [!banner-icon] 👋
    banner-titleMoves inline title next to the icon (requires banner-icon)
    y0 to y100Adjust vertical position of the banner (requires banner), from 0 to 100 in steps of 5
  10. Customize Table and Bases appearance

    main

    Use these classes to modify the styling of tables and Bases views.

    Tables:

    ClassDescription
    table-nowrapDisable line wrapping in table cells
    table-wrapForce line wrapping in table cells
    table-centerCenter small tables narrower than line width
    table-numbersAdd row numbers to tables
    table-tabularUse tabular figures in tables
    table-smallUse small font size in tables
    table-tinyUse tiny font size in tables
    table-linesAdd borders around all table cells
    row-linesAdd borders between table rows
    col-linesAdd borders between table columns
    row-altAdd striped background to alternating table rows
    col-altAdd striped background to alternating table columns
    row-hoverHighlight rows on hover

    Bases:

    ClassDescription
    bases-row-altAdd striped background to alternating Bases table view rows
    bases-col-altAdd striped background to alternating Bases table view columns
    bases-plainHide embedded Bases toolbar