Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to deploy to Github Pages? #12

Open
ecarrara opened this issue Aug 24, 2023 · 3 comments
Open

How to deploy to Github Pages? #12

ecarrara opened this issue Aug 24, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest

Comments

@ecarrara
Copy link
Owner

No description provided.

@ecarrara ecarrara added the documentation Improvements or additions to documentation label Aug 24, 2023
@sabitm
Copy link

sabitm commented Sep 7, 2023

Hi, thanks for creating this tool! I'm eager to try this out for my blog and I couldn't figure out how to serve the dist files locally. Is there supposed to be a index.html file in it (currently missing)?

Edit: Uhh, nevermind. Just fire up a simpe http server and pointed to one of the (converted) markdown file works.

Edit2: But, that's not how github pages works right?

Edit3: Ok, got it working for github pages. Here is the step-by-step:

  • Add index.md (that will act as entry point) in your obsidian vault.
  • Run obsidian-garden build with proper --base-url option (your gh pages url) and point the OUTPUT_DIRECTORY to your github repo.
  • Add empty .nojekyll file in your repo to fix the path issue
  • Commit and push

@ecarrara ecarrara added the good first issue Good for newcomers label Sep 7, 2023
@ecarrara
Copy link
Owner Author

ecarrara commented Sep 7, 2023

@sabitm thanks for using obsidian-garden!

Currently this project has no documentation other than the README. :(

You can see a example of how to publish notes to GitHub Pagas in this MR: https://github.com/ClaraSantosmf/FATEC/pull/1/files (see site.yaml and build.sh files).

@sabitm
Copy link

sabitm commented Sep 7, 2023

@ecarrara No worries. I've already figured it out now and use it in my GH pages. It works beautifully and had no issues so far (plus it's responsive!). All I can say is thanks for making this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest
Projects
Status: 📋 Backlog
Development

No branches or pull requests

2 participants