Giter Site home page Giter Site logo

better-roam-research's Introduction

Better Roam Research

This is one of the most popular minimal themes for Roam Research, with system-level Dark Mode support.

👀 How does it look? See the preview below.

💬 Got feedback? Say hi on Twitter.

🔥 Want to contribute? Edit the theme.

How to use

  1. Inside Roam Research, create a page named exactly roam/css

  2. Create a [[Better Roam Research]] bullet point.

  3. Create a child code block inside it (you can write three backticks to create it: ```) and change it to css

  4. Paste this in the code block @import url("https://linuz90.github.io/better-roam-research/main.css");

NEW: If you want to force light or dark mode, use light.css or dark.css respectively instead of main.css (which uses system detection instead).

It will look like this:

The theme will change when I push updates in this repo ⚡️

Change Accent Color

Just add an extra CSS block and change the --accent-color root variable to customize the theme accent color.

Preview

Light:

When Dark Mode is enabled on your computer:

This theme improves many areas of Roam, like the Kanban:

Here it is without the theme, for reference:

Editing this theme

To create this theme I'm using the SCSS syntax. .scss files are compiled into regular CSS files used for the theme.

To edit the theme, install Sass here.

Then compile the files running this command in the project folder:

sass .:. --no-source-map --watch

The main.scss file imports the main components of the theme, using the dark mode based on the system preference.

The light.scss and dark.scss files instead only import the respective palettes.

The theme styling itself is in components/style.scss, the most important file.

better-roam-research's People

Contributors

alanzchen avatar linuz90 avatar matsenas avatar tschoffelen avatar zyst avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

better-roam-research's Issues

Favicon only for youtube?

Screenshot 2021-01-25 at 12 53 42

I tried to use the favicon js. But saw that youtube favicon was already active but not other sites.
How can I use it for all websites without them being duplicated?

Delete Page modal is not visible

The confirmation modal is hidden when using this theme. I can look into it a bit during the week but wanted to note the issue.

image

image

Youtube embed size not work

I REALLY love the theme very much.

Simple and Beatiful

But maybe 210110, the youtube embed size change not work. It turned to the orginal theme size. For me, it is too small to watch the video.
How can I fix it in this css theme

dark.css (forced theme) doesn't have --accent-color

image

https://linuz90.github.io/better-roam-research/dark.css doesn't have --accent-color declaration.

So, the color of the link was displayed in white.
There is --accent-color in light.css, but not in dark.css.
It seems to be a mistake.

Block Embed bug??

Is this a bug when I make a [block embed], the background in the [block embed] is dark even if OS is in Light Mode?

Highlight text in darkmode

Hi, thanks for the theme.

I tried it in darkmode, somehow the highlight text looks like this. It is not like your preview picture. Is it a bug or did Roam change something?

image

Code blocks in dark mode are white

When using the code block feature in dark mode, the output appears with a white background which can feel a bit blinding and out of place in comparison to the rest of the themes aesthetic.
9C3BB6C1-C173-4A17-8EC2-7F5EA931FB0F

The delete button text has low contrast

As you can see from this image, the color of the delete button is wrong, maybe this has also propagated to other parts of the application (needs further exploration).

image

Manual Light Mode Possible?

Hi, love this theme!

I was just wondering if it was possible to enable the light mode despite having my Mac set on dark mode?

missing style in help panel view

Screenshot 2021-02-23 at 10 20 42

css quick fix =>

#app > div > div.rm-help-popup.react-draggable > div.react-resizable > div.rm-help-results > div.rm-help__left-panel.sticky > div.rm-help-categories {
  color: black
}

Screenshot 2021-02-23 at 10 22 23

Adjustable font size

I have some trouble reading off a screen so I prefer to increase font size of blocks. I don't really like using zoom because it also zooms in the chrome (such as the search bar), which leaves less space for the actual work.

I added this below the import line on the [[roam/css]] page:

:root {
  --font-size: 15pt;
}

Which mostly works, but there are a few issues:

  1. The bullet points are now misaligned from the block they belong to
  2. The sidebar text doesn't resize at all

It would be nice if there was a css variable I could tweak that would adjust the text size for blocks (both in the main area as well as the sidebar) while leaving everything else as normal.

If you're not interested in implementing this feel free to close this issue, I just thought it might be something other people want as well.

Block quote

You don't seem to support block quotes yet—the formatting looks a little odd. This would be nice :)

Nice theme though—thanks.

Screenshot 2020-12-08 at 12 13 37

CSS file is 404

Previously was using this theme from the URL https://linuz90.github.io/better-roam-research/src/css/main.css, which is now 404. Didn't realized it had moved – might want to setup a redirect to avoid breaking existing themes!

Highlighting in dark mode

image

In the sample image, the highlighted text is readable. However, there seems to be an issue when I am highlighting. Using macOS and chrome. Any help would be great! Thanks.

Suggestion: Colored Tags and Kanban Blocks

I've started using colored tags. I've been doing this by having my own css code after the import line for your theme.

@import url("https://linuz90.github.io/better-roam-research/main.css");
/* Custom data tags From Leyendecker Theme*/
span.rm-page-ref[data-tag="iCIMS"] {
    background: #5fa7ad !important;
    color: white !important;
    padding: 3px 7px;
    border-radius: 5px;
    line-height: 2em;
    font-weight: 500;
}
...

I think a great feature of your theme would be the ability to change the color of a Kanban block to match the color of the tag. Maybe just outline it in that color? Something along those lines could make the Kanban board easier to search for a certain colored tag.
I realize this is a bit farfetched since your theme doesn't have its own implementation of colored blocks (I think), but I thought it would be really cool if you were able to get this working.

My Current Kanban set up:

Screen Shot 2020-11-20 at 1 58 53 PM

Disappearing topbar and keyboard shortcuts issue

Better Roam Research now hides Roam's topbar and shows it only when the cursor hovers over it. This introduces an issue when using keyboard shortcuts for interacting with the items in the topbar. For example, cmd+u triggers full text search by focusing the search input, but it becomes unusable as the topbar remains hidden.

Any chance we can find a workaround for this or revert the change until there's a better solution? Thank you!

License

Hi, are you willing to create license for this project?

Queries in darkmode

The frame around queries is very bright in dark mode. Preferably it would be de-emphasized and colored darker like the blocks themselves.

Block reference usage count obscured while using dark mode

Expected behaviour (as seen in sidebar, default theme) - block referenced ones somewhere else in graph
Screen Shot 2020-09-10 at 09 57 40
Actual behaviour (as seen in sidebar, Better Roam Research) - block reference count missing
Screen Shot 2020-09-10 at 09 58 17
Block reference count only appears when hovered over
Screen Shot 2020-09-10 at 09 58 42

Kanban Board visual bug dark mode

The kanban board doesn't have a dark theme, which in my opinion isn't a huge deal. The bigger problem in my eyes is that the font at the top of each column on the board is white against a light grey background.
Screen Shot 2020-09-23 at 10 25 08 PM

block embed text in dark mode is unreadable

Issue:
image

Temporary fix:
added parallel css formatting to fix it:
roam/css -> theme -> /code block (choose css) -> this code inside:
.rm-embed-container { background-color: #21282C; }
image

Result:
image

Text not readable in expanded links / sidebar view

When a mention in the references or sidebar is expended for context, the selected paragraph color scheme (yellow highlight, white font) makes readability very tough

Before expansion
Screen Shot 2020-08-10 at 15 18 48

After expansion
Screen Shot 2020-08-10 at 14 24 10

Add .rm-alias-block to the :not selector for showing external link svg

Today, the theme will add a little link icon next to any external link but excludes any "link" that is actually just an alias to a page.

[this shows the link icon](https://google.com)
[this does not show the link icon]([[November 23rd, 2020]])

It would be nice if this applied to block references as well as page references.

[this currently shows a link icon but likely shouldn't](((44RcQMcMq)))

Here is the part of the codebase that likely needs changing:

div.roam-article span > a:not(.rm-alias-page):after {

.rm-alias is missing --accent-color in light.css

Tittle is pretty self explanatory, but I had to add this to my roam/css:

.rm-alias {
  color: var(--accent-color);
}

I'm using https://linuz90.github.io/better-roam-research/light.css. Not sure if this is true in the other versions.

Thanks for the beautiful theme!

Bottom Padding Issue

So I've found that the newest "framed" theme has a weird 10px bug at the bottom of the viewport:

image

I've tried removing the margin-top: 10px from .roam-center and adding padding-bottom: 10px to .roam-topbar but neither of those seems to properly solve the bug. Just wanted to flag this for you.

Missing dark theme styling

Missing dark theme styling for:

  • Path-based block search (Ctrl-Shift-9)
  • "Find or Create Page" results (top right)

Not sure if this is intentional?

Text in Header blocks is un-styled

Description

It seems that H1, H2, and H3 blocks are not being styled in the latest versions of Roam and Better Roam Research. I didn't dive too deep, but I'm wondering if it's tied to some of the changes to roam/css they made on December 14th.

  • Roam Version: 0.7.6-3f864e82
  • BRR Version: main
  • OS Tested: macOS Catalina and Big Sur
  • Browsers Tested: Safari 14, Firefox 85, Chrome 87

Screenshots

better-roam-research-off

better-roam-research-on

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.