maxence-l / notenote.link Goto Github PK

This project forked from raghudotcc/simply-jekyll

A Jekyll digital garden template, optimized for integration with Obsidian. It aims to enhance discoverability and help you build a personal knowledge base that can scale with time.

Home Page: https://notenote.link

License: MIT License

HTML 46.56% Ruby 1.45% CSS 38.22% JavaScript 13.76%

digital-garden jekyll obsidian zettelkasten notes

notenote.link's Introduction

Notenote.link

Update

Hello, this repo won't be maintained in the near future. Feel free to fork it!

What is this?

A digital garden using a custom version of simply-jekyll, optimised for integration with Obsidian. It is more oriented on note-taking and aims to help you build a nice knowledge base that can scale with time.

Demo is here: notenote.link

If you want to see a more refined example, you can check my notes (in french) at arboretum.link. Build time is approx. 15 seconds, FYI.

Issues are welcome, including feedback ! Don't hesitate to ask if you can't find a solution. 💫

What is different?

Markdown is fully-compatible with Obsidian (including Latex delimiters!)
There are now only notes (no blog posts).
There are cosmetic changes (ADHD-friendly code highlighting, larger font, larger page)
Code is now correctly indented
Wikilinks, but also alt-text wikilinks (with transclusion!) are usable.

How do I use this?

You can click on this link and let the deploy-to-netlify-for-free-script do the rest !

Follow the How to setup this site guide, written by raghuveerdotnet and then adapted for this fork.

If you want to use it with Github Pages, it is possible, please read this.

How can I participate?

Open an issue to share feedback or propose features. Star the repo if you like it! 🌟

How do I customize this for my needs?

Things to modify to make it yours:

Meta content in _layouts/post.html:

<meta content="My linked notebook" property="og:site_name"/>

The favicon and profile are here: assets/img/

The main stuff is in _config.yml:

title: notenotelink.netlify.com
name: notenote.link
user_description: My linked notebook

notes_url: "https://notenotelink.netlify.com/"
profile_pic: /assets/img/profile.png
favicon: /assets/img/favicon.png
copyright_name: MIT

baseurl: "/" # the subpath of your site, e.g. /blog
url: "https://notenotelink.netlify.com/" # the base hostname & protocol for your site, e.g. http://example.com
encoding: utf-8

You may want to change the copyright in _includes/footer.html:
```
<p id="copyright-notice">Licence MIT</p>
```

How do I remove the "seasons" feature for the notes?

Delete what's inside _includes/feed.html and replace it with:

{%- if page.permalink == "/" -%}
    {%- for item in site.notes -%}
        <div class="feed-title-excerpt-block disable-select" data-url="{{site.url}}{{item.url}}">
            <a href="{{ item.url }}" style="text-decoration: none; color: #555555;">
            {%- if item.status == "Ongoing" or item.status == "ongoing" -%}
                <ul style="padding-left: 20px; margin-top: 20px;" class="tags">
                    <li style="padding: 0 5px; border-radius: 10px;" class="tag"><b>Status: </b>{{item.status | capitalize }}</li>
                </ul>
                <p style="margin-top: 0px;" class="feed-title">{{ item.title }}</p>
            {%- else -%}
                <p class="feed-title">{{ item.title }}</p>
            {%- endif -%}
                <p class="feed-excerpt">{{ item.content | strip_html | strip | escape | truncate: 200}}</p>
            </a>
        </div>
    {%- endfor -%}
{%- endif -%}

On command-line, you can run bundle exec jekyll serve then go to localhost:4000 to check the result.

What's coming?

Open-transclude integration in the template, if possible.
Different themes! - Please tell me which you'd like to have!

notenote.link's People

Contributors

Stargazers

Watchers

Forkers

genrihgrigoryan michaelcurrin bananaangst mathefeitosa rubenhm parnassiuss alisynthesis dummifiedme gbocsardi one-data-cookie wind2sing anaelberrouet fannymoini micahchoo thammawat-s filippus-of-stockholm hf6hshfzjiog brimwats1 mosiuropu tjsg1992 dlivinglabs lilsid7 clivusistheseatofthesoul teunispolak ktmeaton nythrox napoler marcbusch ckwmoore raoufuoar soapwad bootlegsorcery wawalker3 mvallet91 markansn tfiers bubblbu sajjad2881 joelchan choperlizer fsiefken mara-li kksworks wooodhead lenis2000 adairrr nateml sankyuubigan daydemir iamjameshall armstrongl wodecki yampml jimbrig rmoliva csb324 mininmd ke3gen thedigitalbrain-net dmkazanskiy lightbridge-ks zhuangbiaowei equalapriori ramellus 2jojo lordmendigo nickburrell signynt ignon itta-ca heartnn bbsmashdown masiunnisa fenton42 ignaciokuchen speculative-technologies xeome justinpocta neuralprobe aethelind kdhingra307 tsfelg copiouswaistcoats goedg bensker nikkiyux runarsf johannakammler alessdangelo steconcode

notenote.link's Issues

The RSS feed seems to have broken with this fork

Embedding Other Notes

Could you please add the feature to embed other MarkDown files using ![[]] syntax just like in Obsidian?

Links require filename and title in YAML to be the same

Expected behaviour: wikilinks point to filename and not title of the note. Like it works on the tag page.

Even better: If we could write wikilinks to the filenames (as is how it works in Obsidian) but the anchor text displayed is taken from the YAML frontmatter title.

I have a naming convention for my files where I use only lowercase letters and might prepend them with for example "q." for quotes. However, I do not necessarily want to display this "q." in front of the title of the note.

Transclusion?

The README says that transclusion for wikilinks is available, but the standard obsidian syntax ![[note]] doesn't work - it just provides a link to the page, with an exclamation point in from of it. So does [[!note]], ![[note#heading]], and ![[note#heading|alt]]. What's the proper syntax?

Sidenotes architecture

Hey!
I'm currently trying to merge this template with another template, and I couldn't figure out how the sidenote function is operating. I saw some conditionals in the content.html in the _include forlder, but couldn't figure out the solution on my own, could you elaborate a bit on how they work?
Thanks in advance!

[Enhancement] Add a dark/light toggle

I really don't understand how to work with Jekyll, so If anyone know how can I add a light/dark button to change the CSS, I will appreciate it !

[resolved] ffi-1.12.2 requires ruby version 2.8 dev

With ruby update, the FFI seems to be broken.
To work, I do this :

gem install ffi -f
bundle update
bundle add webrick
bundle && bundle exec jekyll serve

I dunno if it's possible to pull request this, so I leave it here for future reference.

Seasons explanation

Hello!
First of all, thank you so much for this repo, it really is a wonderful resource, and it fills a huge void imho.
I don't know if the Issues is the right place for this, but could you explain the seasons' function in the front matter? I tried playing around with it, but couldn't figure out what they were for, but I am curious.

Thanks!

how to use different theme?

i dont like how the default light theme looks, how do i use dark themes, do i have to modify css manually?
i use github pages btw

Cross-syncing with obsidian git

I want to know if it's possible to "cross-sync" with an already existing Obsidian git vault, or if I need to always use copy-pasting or some "windows magic" like physical link for note we want to share.

required Frontmatter and metadata in markdowns to showing on site

please, how to remove a requirement of Frontmatter and metadata in markdowns?

I have a very lot markdowns, but links to them required
`---

---`
block in top. In my site they not showing without that Frontmatter.

why link to markdown have not right path?

when I create a markdown and go to him from the menu list,

his path in my browser is "folder/my_markdown", but my markdown is located in "folder/folder2/folder3/my_markdown".

how to fix that?

Sliding Window Mode (Andy Matuschak's Notes Style)

Could you please add an option for Sliding Window Mode (Andy Matuschak's Notes Style).

Even if only a single view on the right would be perfect.

Or anything like Obsidian's templates.

Chinese Filenames

There seems to be a problem with files with Chinese Filenames.
I have my notes in the _notes folder, however only the files with all English filenames are rendered in the website, as shown below.

(The meaning of the note is not important)

(Here it's Okay)

(Inside the link -> all blank)

Thank you in advance for this fantastic theme and your answers

Applying another theme

Stunning work, @Maxence-L! 👏

I'd like to get this up and running, ideally using Hyde. Can you recommend which parts would be necessary to change to get at least a very similar feel, i.e. fixed left sidebar, same colour scheme, and fonts?

Or do you reckon it might be feasible to make this a subpage of a main website built with another theme (like Hyde)?

In the readme, you mention that you're thinking about having the ability to apply different themes. So, maybe this is already on your mind?

Any help would be much appreciated.

Remove DSStore files

These are specific to a machine and a temporary.

I recommend deleting all .DS_Store files and adding .DS_Store to .gitignore

Regarding the use of github pages

Can't we use github pages instead of Netlify? I was just wondering if we really have to use Netlify. I am a noob in all of this, I just want to publish a part of my notes from Obsidian. :)