{"id":25006874,"url":"https://github.com/charleschiugit/logseq-hugo-template","last_synced_at":"2025-04-30T07:52:24.169Z","repository":{"id":41297984,"uuid":"485226322","full_name":"CharlesChiuGit/Logseq-Hugo-Template","owner":"CharlesChiuGit","description":"This is a HUGO website template for Logseq users who wants their published posts to look more like a personal website, using GitHub Pages to host the website and logseq-schrodinger to export your Logseq pages.","archived":false,"fork":false,"pushed_at":"2024-09-30T20:58:27.000Z","size":7475,"stargazers_count":92,"open_issues_count":0,"forks_count":11,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-22T19:53:11.830Z","etag":null,"topics":["github-pages","hugo","logseq"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CharlesChiuGit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-04-25T04:48:29.000Z","updated_at":"2025-02-22T18:24:59.000Z","dependencies_parsed_at":"2024-06-05T16:39:55.038Z","dependency_job_id":"ae9c79f9-1b53-415b-92c8-5b5982b338a2","html_url":"https://github.com/CharlesChiuGit/Logseq-Hugo-Template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CharlesChiuGit%2FLogseq-Hugo-Template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CharlesChiuGit%2FLogseq-Hugo-Template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CharlesChiuGit%2FLogseq-Hugo-Template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CharlesChiuGit%2FLogseq-Hugo-Template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CharlesChiuGit","download_url":"https://codeload.github.com/CharlesChiuGit/Logseq-Hugo-Template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246326758,"owners_count":20759437,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-pages","hugo","logseq"],"created_at":"2025-02-05T01:52:08.174Z","updated_at":"2025-03-30T14:10:37.206Z","avatar_url":"https://github.com/CharlesChiuGit.png","language":"HTML","funding_links":["https://buymeacoffee.com/XXX"],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\r\n    Logseq-Hugo-Template\r\n\u003c/h1\u003e\r\n\r\n\u003cp align=\"center\"\u003e\r\n    \u003ca href=\"https://github.com/CharlesChiuGit/Logseq-Hugo-Template/stargazers\"\u003e\r\n    \u003cimg\r\n        alt=\"GitHub Repo stars\"\r\n        src=\"https://img.shields.io/github/stars/CharlesChiuGit/Logseq-Hugo-Template?color=957FB8\u0026logo=starship\u0026style=for-the-badge\"\u003e\r\n    \u003c/a\u003e\r\n    \u003ca href=\"https://github.com/CharlesChiuGit/Logseq-Hugo-Template/issues\"\u003e\r\n    \u003cimg\r\n        alt=\"GitHub issues\"\r\n        src=\"https://img.shields.io/github/issues-raw/CharlesChiuGit/Logseq-Hugo-Template?color=DCA561\u0026logo=gitbook\u0026logoColor=d9e0ee\u0026style=for-the-badge\"\u003e\r\n    \u003ca href=\"https://github.com/CharlesChiuGit/Logseq-Hugo-Template/contributors\"\u003e\r\n    \u003cimg\r\n        alt=\"GitHub contributors\"\r\n        src=\"https://img.shields.io/github/contributors/CharlesChiuGit/Logseq-Hugo-Template?color=%2398BB6C\u0026logo=opensourceinitiative\u0026logoColor=d9e0ee\u0026style=for-the-badge\"\u003e\r\n    \u003c/a\u003e\r\n    \u003cimg\r\n        alt=\"GitHub code size in bytes\"\r\n        src=\"https://img.shields.io/github/languages/code-size/CharlesChiuGit/Logseq-Hugo-Template?color=%237E9CD8\u0026logo=gitlfs\u0026logoColor=d9e0ee\u0026style=for-the-badge\"\u003e\r\n\u003c/p\u003e\r\n\r\n\u003cp align=\"center\"\u003e\r\n    \u003cimg\r\n        alt=\"HTML\"\r\n        src=\"https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge\u0026logo=html5\u0026logoColor=white\"\u003e\r\n    \u003ca href=\"https://logseq.com/#/\"\u003e\r\n    \u003cimg\r\n        alt=\"Logseq\"\r\n        src=\"https://img.shields.io/static/v1?label=\u0026message=LOGSEQ\u0026color=002B35\u0026style=for-the-badge\"\u003e\r\n    \u003c/a\u003e\r\n\u003c/a\u003e\r\n\r\n## Description\r\n\r\nThis is a [HUGO](https://gohugo.io/) website template for [Logseq](https://logseq.com/#/) users who want their published posts to look more like a personal website, using [GitHub Pages](https://pages.github.com/) to host the website and [logseq-schrodinger](https://github.com/sawhney17/logseq-schrodinger) to export your Logseq pages.\r\n\r\n\u003cp align=\"center\"\u003e\r\n        \u003cimg src=\"./src/thanos_logseq_hugo.svg\" style=\"width:50%\"/\u003e\r\n\u003c/p\u003e\r\n\r\n## Credits\r\n\r\nCredits to [Alex QWxleA](https://github.com/QWxleA) and [Aryan Sawhney](https://github.com/sawhney17) for inspiring this template.\r\n\r\n---\r\n\r\n## Why use [Logseq-Hugo-Template](https://github.com/CharlesChiuGit/Logseq-Hugo-Template) to build a website?\r\n\r\nAlthough the native publish function in Logseq is very convenient, it's output result is more like a read-only Logseq, rather than a personal website.\r\n\r\n### Why HUGO?\r\n\r\nYou can use [Markdown](https://www.markdownguide.org/) to write your posts/contents in HUGO.\r\n\r\n### Why GitHub Pages?\r\n\r\nYou can host your website directly from your GitHub repo, and it cost you nothing.\r\n\r\n---\r\n\r\n## 🧱 Template Structure\r\n\r\n```bash\r\n├── archetypes/    # A piece of content that's common to all of the content on your website.\r\n│   └── default.md\r\n├── content/    # Where you store all the content for your website.\r\n│   ├── assets/    # Things from LogseqGraph/assets, used in posts.\r\n│   │   └── test.png\r\n│   ├── pages/    # Revised Logseq pages with metadata sections for Hugo.\r\n│   │   └── random page from logseq.md\r\n│   ├── archives.md\r\n│   └── search.md\r\n├── .github/    # Define GitHub action to help deploy in one click.\r\n│   └── workflows/\r\n│       └── publish.yml\r\n├── layouts/    # Where you define your layout for your website.\r\n│   ├── partials/\r\n│   │   └── backlinks.html    # Simulate backlinks function in Hugo.\r\n│   └── shortcodes/\r\n│       ├── logseq/    # Translation between Logseq and Hugo.\r\n│       │   ├── mark.html\r\n│       │   ├── orgCAUTION.html\r\n│       │   ├── orgEXAMPLE.html\r\n│       │   ├── orgIMPORTANT.html\r\n│       │   ├── orgNOTE.html\r\n│       │   ├── orgPINNED.html\r\n│       │   ├── orgQUOTE.html\r\n│       │   ├── orgTIP.html\r\n│       │   └── orgWARNING.html\r\n│       ├── contact.html\r\n│       ├── hint.html\r\n│       └── search.html\r\n├── themes/    # Where you can apply pre-build themes or your own theme.\r\n│   └── random-theme/   # In this repo, PaperMod is the default theme.\r\n├── config.yml    # The main settings page for your website.\r\n└── .gitignore    # This is to prevent unwanted files be tracked by Git.\r\n```\r\n\r\n## 🪜 Workflow\r\n\r\nThis workflow assumes your know something about GitHub.\r\n\r\n1. Click the green `Use this template` button to fork this template repo.\r\n2. Rename the forked repo to `{your-GitHub-username}.github.io`, e.g. GitHubUser.github.io.\r\n3. Clone the repo.\r\n4. Configure `config.yml`.\r\n5. Export your Logseq pages to `content/pages`, using [logseq-schrodinger](https://github.com/sawhney17/logseq-schrodinger).\r\n6. Push it to `git@github.com:{username}/{username}.github.io.git`.\r\n7. After it's pushed, go to \"Settings\" \u003e \"Pages\" \u003e \"Source\" \u003e Choose \"gh-pages\" branch. (auto-created by [GitHub actions](https://github.com/features/actions))\r\n8. Wait few minutes for GitHub to deploy.\r\n9. You should now see your website in `https://{username}.github.io/`, e.g. `https://githubuser.github.io/`! 🍻\r\n\r\n## ✨ Things you MUST modify\r\n\r\n### In `config.yml`\r\n\r\n```yml\r\nbaseURL: https://githubuser.github.io # 1. All lowercase. 2. Don't put `/` after `.io`.\r\nlanguageCode: en-us\r\ntitle: Linus Torvalds # Your name or the website title.\r\ntheme: 'PaperMod'\r\n\r\nparams:\r\n  homeInfoParams:\r\n    Title: Sup bruh 😎 # homepage title.\r\n    Content: This is something shows in your homepage. # homepage content.\r\n\r\n  socialIcons: # optional\r\n    - name: 'github'\r\n      url: 'https://github.com/XXX'\r\n    # - name: \"youtube\"\r\n    #   url: \"https://www.youtube.com/channel/XXX\"\r\n    - name: 'twitter'\r\n      url: 'https://twitter.com/XXX'\r\n    # - name: \"kofi\"\r\n    #   url: \"https://buymeacoffee.com/XXX\"\r\n    # - name: \"rss\"\r\n    #   url: \"https://XXX.github.io/index.xml\"\r\n  ShowReadingTime: true\r\n  author: 'Linus Torvalds' # Your name.\r\n  contact: 'LinusT@example.com' # Your email.\r\n  feedlinks: true\r\n  copyright: '\u003c!--Creative Commons License--\u003eThis site is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/).\u003c!--/Creative Commons License--\u003e'\r\n  mobileMenu: true\r\n\r\n  #Google Analytics 4 optional\r\n  env: #production\r\n  GoogleAnalytics: \"G-00000XXXXX\" \r\n  sitemap:\r\n    changefreq: daily\r\n    filename: sitemap.xml\r\n    priority: 0.5\r\n```\r\n\r\n### In `content/pages` and `content/assets`\r\n\r\n1. Make pages public.\r\n2. Click on the three dots in the top right corner in Logseq and click `Export public pages to hugo`, via [logseq-schrodinger](https://github.com/sawhney17/logseq-schrodinger).\r\n3. Unzip the file and move the contents into `content/`.\r\n\r\n※ Noted: The marketplace version of logseq-schrodinger might have some file permission issues. Use the GitHub version one instead.\r\n\r\n## How to set the Google Analytics 4?\r\n\r\n1. Apply [Google Analytics 4](https://analytics.google.com/)\r\n2. Write the GA4-ID to config.yml\r\n3. Set[Google Search Console](https://search.google.com/search-console/welcome)and add sitemap\r\n\r\n## How to change theme?\r\n\r\nHUGO provides lots of prebuild themes.\r\n\r\n1. [Install HUGO and Go](https://gohugo.io/getting-started/installing/).\r\n2. [Follow the steps](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme).\r\n\r\n※ Noted: Structure and configurations might vary from theme to theme.\r\n\r\n## ⚠️ Limitations\r\n\r\n[logseq-schrodinger](https://github.com/sawhney17/logseq-schrodinger) is very much a work-in-progress. Please check if there's anything wrong about your post after exported. File an issue if you think something is a bug.\r\n\r\n### [What works on logseq-schrodinger so far](https://github.com/sawhney17/logseq-schrodinger#what-works)\r\n\r\n- Local Hugo links (but Logseq uses one folder for everything, so Hugo does too)\r\n- Block refs(!) — On conversion the block is pulled from the other location\r\n- Images\r\n  - Notice that the uppercase filenames might be transformed to lowercase, making the remote images invalid, please double-check that.\r\n- Basic Markdown styling (including highlighting!)\r\n\r\n## Issues\r\n\r\n[Issues for logseq-schrodinger](https://github.com/sawhney17/logseq-schrodinger#issues)\r\n\r\n[Issues for this template](https://github.com/CharlesChiuGit/Logseq-Hugo-Template/issues)\r\n\r\n## Sample Sites\r\n\r\n- \u003chttps://aryansawhney.com\u003e\r\n- \u003chttps://blog.charliie.dev/\u003e\r\n\r\n## License\r\n\r\nDistributed under the MIT License. See `LICENSE` for more information.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharleschiugit%2Flogseq-hugo-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcharleschiugit%2Flogseq-hugo-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharleschiugit%2Flogseq-hugo-template/lists"}