search

paulmartins / hugo-digital-garden-theme

Hugo Theme for digital gardening projects.
MIT License
89 stars 43 forks source link

Update the docments #5

Closed nanqunchen closed 2 years ago

nanqunchen commented 2 years ago
  1. Update the git submodule command to make the directory the same name as the project.
  2. Add a command description on how to demo the example site.
netlify[bot] commented 2 years ago

Deploy Preview for hugo-digital-garden-demo ready!

Name Link
Latest commit db14f37aea01670dd66131bb604b298fddb8001b
Latest deploy log https://app.netlify.com/sites/hugo-digital-garden-demo/deploys/62e9dc262e17900008b53d51
Deploy Preview https://deploy-preview-5--hugo-digital-garden-demo.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

james-s-w-clark commented 2 years ago

This looks great - thanks! Is it worth saying about how the users should create their own site (copy files from example site to root, change themes directory to ./themes, etc.), where+how to run it, and that they can compare to the example site by running both hugo servers?

nanqunchen commented 2 years ago

@IdiosApps It may belong to hugo's mechanism but I agree it does help. Please help to add some content to the document if you like. Thanks.

james-s-w-clark commented 2 years ago

@nanqunchen I think you phrased it well before. How about this (quick draft)?

If you want to have your content folder in your root directory, you can copy that from the exampleSite folder to your root directory. In the root directory's config.toml you will need to change the themesdir: themesdir = "./themes". You can now run hugo server in the root directory of your project, and Hugo will start your website locally on an available port.

If you want to compare the website from this to the example site, you can start hugo server in the exampleSite directory too. Hugo will use different ports, so you can compare the rendered pages with each other.

To create custom styling, you can create ./static/css/my_style.css. It will override the theme's styling

I added a note on custom styling as it took me little while to figure out where it should go. If it's helpful, I have an example of changing the fonts and table formatting: https://github.com/IdiosApps/IdiosApps.github.io/blob/main/static/css/my_style.css, https://idiosapps.github.io/garden/games-for-socials/

I think it's worth calling out how to compare a user's site to their exampleSite, side-by-side

nanqunchen commented 2 years ago

That's great. The css file is also a good add-on. Thanks! Please create a pull request. @IdiosApps