Skip to content

Commit

Permalink
Added more instructions and release note
Browse files Browse the repository at this point in the history
  • Loading branch information
Peter Yuen authored and Peter Yuen committed Apr 16, 2022
1 parent 43cab1a commit 6c9a341
Show file tree
Hide file tree
Showing 4 changed files with 92 additions and 5 deletions.
1 change: 0 additions & 1 deletion .data_paths

This file was deleted.

3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,9 @@ cython_debug/
.vs
.vscode
.data_path
.data_paths

backup
data
public
build
build
73 changes: 73 additions & 0 deletions CONFIG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# `netlify.toml` options

> Explains the effects and details of each option in `netlify.toml`'s `build.environment`.
## Required

### `SITE_URL`
URL to your netlify site.

### `REPO_URL`
GitHub repo URL where your Markdown files are hosted.

### `LANDING_PAGE`
The Markdown file to use as your landing page when home page landing button is clicked. Note that if `SLUGIFY` is turned on (default is on), you need to slugify the folder name here. E.g. if you are using `/somewhere far/some funny note.md` as landing page, enter `LANDING_PAGE=/somewhere-far/some-funny-note.md`.

## Optional

### `SITE_TITLE`
Site title on landing page. HTML, CSS, emojis supported. Default: "Someone's Second 🧠".

### `SITE_TITLE_TAB`
Site title in browser tab, leaving blank to use `SITE_TITLE`. This is for people who added HTML code in `SITE_TITLE` but want to display a clean name in the browser tab. Default: "".

### `LANDING_TITLE`
Site title on landing page. HTML, CSS, emojis supported. Default: "I love obsidian-zola! 💖.".

### `LANDING_DESCRIPTION`
Site description on landing page. HTML, CSS, emojis supported. Default: "I have nothing but intelligence.".

### `LANDING_BUTTON`
Text to display on button in home page. HTML, CSS, emojis supported. Default: "Click to steal some👆".

### `TIMEZONE`
Site Timezone. Default: "Asia/Hong_Kong". I guess now you know where I am from :)

### `SORT_BY`
How to sort your pages inside a folder ("title" or "date"). Default: "title". Folders are sorted alphabetically, cannot change this.

### `GANALYTICS`
Google Analytics Measurement ID. Default: "".

### `SLUGIFY`
Whether to slugify URLs. Set to "" to disable. Default: "y".

### `HOME_GRAPH`
Shows knowledge graph on home page. Put "" to disable. Default: "y".

### `PAGE_GRAPH`
Shows knowledge graph on every page. Put "" to disable. Default: "y".

### `LOCAL_GRAPH`
Page graph only shows directly connected nodes. Default: "".

### `GRAPH_LINK_REPLACE`
If "y", clicking on graph link replaces current tab. Else, page is opened in new tab. Default: "".

### `STRICT_LINE_BREAKS`
Whether to use standard Markdown strict line breaks (single line breaks ignored unless followed by 2 whitespaces), or to use Obsidian-style line breaks. If "y", strict line break is used, else, Obsidian-style is used. Users who use LaTEX must set this to "y" for equations to render properly. Default: "y".

## Animations
`Animate.css`, `Hover.css` and `CSShake` classes can be used in all fields where HTML + CSS are supported. Refer to example repo's setup on how to do so.


## Do Not Touch
Do not change theses:
- `PYTHON_VERSION`
- `ZOLA_VERSION`


# FAQs

## How do I exclude notes from the website?
Use a `.gitignore` file to prevent pushing private notes to a public repository.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,21 @@ Credits: This repo was forked from [Adidoks](https://github.com/aaranxu/adidoks)
Special Thanks: Wikilink parsing is powered by [obsidian-export](https://github.com/zoni/obsidian-export).

# Announcements
**v1.2.0 More Features! 🥳**

Bug Fixes:

- Added the ability to deal with empty links (re-directed to 404 page)
- Added the ability to deal with special characters in filenames
- Added the ability to cope with overlapping name between sections and pages (so now u can have both `repeated/` and `repeated.md` in the same directory)

Improvements:

- Ability to configure tab-opening behaviour when clicking on graph node (same / new tab)
- Ability to configure line break parsing (strict vs Obsidian-style)
- Ability to configure graph display preference, you can now choose to display only directly connected nodes!


**v1.1.0 Thanks for the support and Feedback 💓**

I never expected to receive such attention from my Reddit post. Thank you for supporting this project! I have heard your feedback and made some minor but urgent improvements. I will continue to implement the rest of the crucial requests over the next few days!
Expand Down Expand Up @@ -43,7 +58,7 @@ I never expected to receive such attention from my Reddit post. Thank you for su
- Be Fancy: All text field settings in `netlify.toml` (e.g. `LANDING_TITLE`) supports HTML syntax. And I added `Animate.css` + `Hover.css` + `CSShake` for those of you who want to add a personal touch~

**Step 4: Issues & Feature Requests**
- If you encounter any issues, just post in the `Issues` tab. It would be good to include a copy of the error log found in the Netlify panel if the issue is related to deployment.
- If you encounter any issues, first refer to [Config+FAQ](https://github.com/ppeetteerrs/obsidian-zola/blob/main/CONFIG.md). If still unsolved, just post in the `Issues` tab. It would be good to include a copy of the error log found in the Netlify panel if the issue is related to deployment.
- If you have any feature request, do post an issue also. However, please this repo is intended as a one-file setup. Advanced features / detailed configurability will not be supported unless it is wanted by most users. However, I can provide help for you to implement a fork that suits your needs 🥂.

# Example Site
Expand Down Expand Up @@ -84,10 +99,9 @@ The [example site](https://peteryuen.netlify.app/) shows the capabilities of `ob

# Gotchas
1. Do not have files with name `index.md` or `_index.md`
2. Do not have files that have the same name as its subfolder (e.g. having both `.../category1.md` and `.../category1/xxx.md` is not allowed)
2. ~~Do not have files that have the same name as its subfolder (e.g. having both `.../category1.md` and `.../category1/xxx.md` is not allowed)~~ (Fixed)
3. `LANDING_PAGE` needs to be set to the slugified file name if `SLUGIFY` is turned on (e.g. to use `I am Home.md`, `LANDING_PAGE` needs to be `i-am-home`)

# WIPs / Ideas
- (Will do) Configurable line breaks. Currently, users need to allow standard Markdown line break conventions (single line breaks are ignored) because of some LaTEX bugs. It will be fixed soon and made configurable.
- (Probably will do) Backlinks / Mentioned in
- (Maybe) Lottie animations?

0 comments on commit 6c9a341

Please sign in to comment.