20 |
21 | ## A note about GitHub Pages
22 | > [!NOTE]
23 | > **Update (January 2023)**: it seems that GitHub Pages supports custom plugins now, thanks to GitHub Actions ([view relevant discussion](https://github.com/maximevaillancourt/digital-garden-jekyll-template/discussions/144)).
24 |
25 | GitHub Pages only partially supports this template: to power the interactive notes graph, this template uses a custom Jekyll plugin to generate the graph data in [`notes_graph.json`](https://github.com/maximevaillancourt/digital-garden-jekyll-template/blob/7ac331a4113bac77c993856562acc2bfbde9f2f7/_plugins/bidirectional_links_generator.rb#L102), and [GitHub Pages doesn't support custom Jekyll plugins](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#plugins).
26 |
27 | If you want to use the graph with GitHub Pages, you may try building your garden locally using Jekyll then pushing the result to GitHub Pages.
28 |
29 | Alternatively, you may deploy your garden to Netlify and it'll work out of the box. [I wrote a guide explaining how to set this up](https://maximevaillancourt.com/blog/setting-up-your-own-digital-garden-with-jekyll).
30 |
31 | If you don't care about the graph, you can simply remove it from this layout, [as explained here](https://github.com/maximevaillancourt/digital-garden-jekyll-template/discussions/132#discussioncomment-3625772).
32 |
33 | ## License
34 |
35 | Source code is available under the [MIT license](LICENSE.md).
36 |
--------------------------------------------------------------------------------
/_config.yml:
--------------------------------------------------------------------------------
1 | title: My digital garden
2 | include: ['_pages']
3 | exclude: ['_includes/notes_graph.json']
4 | # You may need to change the base URL depending on your deploy configuration.
5 | baseurl: ''
6 |
7 | # If you are using a host that cannot resolve URLs that do
8 | # not end with .html (such as Neocities), set this to 'true'.
9 | use_html_extension: false
10 |
11 | # Set to `true` to open non-internal links in new tabs, or
12 | # set to `false` to open non-internal links in current tab.
13 | open_external_links_in_new_tab: true
14 |
15 | # Set to `true` to replace tweet URLs with Twitter embeds.
16 | # Note that doing so will negatively the reader's privacy
17 | # as their browser will communicate with Twitter's servers.
18 | embed_tweets: false
19 |
20 | permalink: pretty
21 | relative_permalinks: false
22 |
23 | plugins:
24 | - jekyll-last-modified-at
25 |
26 | sass:
27 | sass_dir: _sass
28 | style: :compressed
29 |
30 | collections:
31 | notes:
32 | output: true
33 | permalink: /:slug
34 |
35 | defaults:
36 | - scope:
37 | path: "**/*"
38 | values:
39 | layout: "default"
40 | - scope:
41 | path: "_notes/**/*.md"
42 | values:
43 | layout: "note"
44 |
--------------------------------------------------------------------------------
/_includes/footer.html:
--------------------------------------------------------------------------------
1 | This is the footer. Include anything you'd like here, like a link to an
7 |
13 |
14 | {{ page.title }}
8 | 12 |
15 |
16 | {{ content }}
17 |
19 |
20 |
21 |
40 |
41 | This line appears after every note.
18 |Notes mentioning this note
22 | {% if page.backlinks.size > 0 %} 23 |
24 | {% for backlink in page.backlinks %}
25 |
29 | {% endfor %}
30 |
31 | {% else %}
32 |
33 |
34 |
38 | {% endif %}
39 | 35 | There are no notes linking to this note. 36 |
37 |
94 |
95 | You can also ==highlight some content== by wrapping it with `==`.
96 |
97 | Non-latin languages are supported too: ==你好==, ==안녕하세요==, ==こんにちは==.
98 |
99 | ### Code syntax highlighting
100 |
101 | You can add code blocks with full syntax color highlighting by wrapping code snippet in triple backticks and specifying the type of the code (`js`, `rb`, `sh`, etc.):
102 |
103 | ```js
104 | // Here's a bit of JavaScript:
105 | if (a === b || c == d)
106 | console.log('hello!')
107 | ```
108 |
109 | ```rb
110 | # And now some Ruby
111 | def foo(bar)
112 | "baz"
113 | end
114 | ```
115 |
116 | ```sh
117 | $ cat /dev/urandom | grep "the answer to life" # shell scripts look nice too
118 | ```
119 |
120 |
121 | ### Next steps
122 |
123 | This digital garden template is free, open-source, and [available on GitHub here](https://github.com/maximevaillancourt/digital-garden-jekyll-template).
124 |
125 | The easiest way to build your own digital garden based on this template is to read this [step-by-step guide explaining how to set this up from scratch](https://maximevaillancourt.com/blog/setting-up-your-own-digital-garden-with-jekyll).
126 |
127 | Go forth, have fun, and learn new something every day! ✌️
128 |
--------------------------------------------------------------------------------
/_notes/안녕하세요.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: 안녕하세요
3 | ---
4 |
5 | This template supports any language. Come as you are! :)
6 |
7 |
--------------------------------------------------------------------------------
/_pages/about.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: page
3 | title: About
4 | permalink: /about
5 | ---
6 |
7 | *This is an about page.*
8 |
9 | Feel free to tell the world about what you love! 😍
10 |
--------------------------------------------------------------------------------
/_pages/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | layout: page
3 | title: Home
4 | id: home
5 | permalink: /
6 | ---
7 |
8 | # Welcome! 🌱
9 |
10 |