{"id":16347884,"url":"https://github.com/victoriadrake/neofeed-theme","last_synced_at":"2025-11-06T00:30:36.701Z","repository":{"id":48085888,"uuid":"327305114","full_name":"victoriadrake/neofeed-theme","owner":"victoriadrake","description":"A personal feed for Neocities, GitHub Pages, or anywhere else, built with Hugo. #IndieWeb friendly and all yours. It's better than Twitter.","archived":false,"fork":false,"pushed_at":"2024-08-17T11:11:56.000Z","size":1085,"stargazers_count":89,"open_issues_count":3,"forks_count":35,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-11T12:17:47.369Z","etag":null,"topics":["feed","hfeed","hugo","indieweb","personal-website","static-site","static-site-generator"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/victoriadrake.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","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},"funding":{"github":"victoriadrake","custom":["https://neocities.org/donate/"]}},"created_at":"2021-01-06T12:29:19.000Z","updated_at":"2025-01-03T19:39:34.000Z","dependencies_parsed_at":"2024-06-18T21:36:21.150Z","dependency_job_id":"bf5ea220-19a1-4a3b-91a7-934d0de7eb17","html_url":"https://github.com/victoriadrake/neofeed-theme","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victoriadrake%2Fneofeed-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victoriadrake%2Fneofeed-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victoriadrake%2Fneofeed-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victoriadrake%2Fneofeed-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/victoriadrake","download_url":"https://codeload.github.com/victoriadrake/neofeed-theme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239475940,"owners_count":19645042,"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":["feed","hfeed","hugo","indieweb","personal-website","static-site","static-site-generator"],"created_at":"2024-10-11T00:46:47.817Z","updated_at":"2025-11-06T00:30:36.666Z","avatar_url":"https://github.com/victoriadrake.png","language":"HTML","funding_links":["https://github.com/sponsors/victoriadrake","https://neocities.org/donate/"],"categories":[],"sub_categories":[],"readme":"# ![Twinkling star](https://github.com/victoriadrake/neofeed-theme/blob/379bdeb10c934ca8e96075543b51ad993be4e265/images/littlestar.gif?raw=true) Neofeed ![Twinkling star](https://github.com/victoriadrake/neofeed-theme/blob/379bdeb10c934ca8e96075543b51ad993be4e265/images/littlestar.gif?raw=true)\n\n(っ◔◡◔)っ A personal timeline for the IndieWeb that can deploy to Neocities and GitHub Pages.\n\n- Like Twitter but it doesn't suck\n- Like Geocities except it exists\n\n✨ Neofeed is a beginner-friendly starter site to learn to use Hugo and generate awesome static websites with continuous delivery. This enriched Hugo theme helps you create a plain HTML static website. You can deploy to Neocities and GitHub Pages with continuous deployment workflows out of the box!\n\n🖌 Use CSS skins to switch it up and make it your own. Feeling brave? All the source code is at your fingertips. Go nuts! 🥜\n\n- [Screenshots](#screenshots)\n- [The General Idea](#the-general-idea)\n- [Git Started](#git-started)\n  - [Deploy without Hugo (stand alone site)](#deploy-without-hugo-stand-alone-site)\n  - [Use as a Hugo theme](#use-as-a-hugo-theme)\n    - [1. Add this theme](#1-add-this-theme)\n    - [2. Update your `config` file](#2-update-your-config-file)\n    - [3. Write and deploy](#3-write-and-deploy)\n- [IndieWeb Features](#indieweb-features)\n  - [Different Post Types](#different-post-types)\n- [Learn and Customize with Hugo](#learn-and-customize-with-hugo)\n  - [Edit or Create a CSS Skin](#edit-or-create-a-css-skin)\n  - [Totally Optional Cool Stuff](#totally-optional-cool-stuff)\n    - [Plausible](#plausible)\n    - [Web Monetization](#web-monetization)\n- [Contributing](#contributing)\n  - [Values](#values)\n\n## Screenshots\n\nWith just CSS you can make your Neofeed look like _anything you can imagine._ Here are a few options for you to use, change, or extend right out of the box.\n\n\u003cimg width=\"500\" alt=\"Neofeed with macintosh CSS skin\" src=\"https://raw.githubusercontent.com/victoriadrake/neofeed-theme/master/images/macintosh.png\" /\u003e\n\u003cimg width=\"500\" alt=\"Neofeed with minimal CSS skin\" src=\"https://raw.githubusercontent.com/victoriadrake/neofeed-theme/master/images/minimal.png\" /\u003e\n\u003cimg width=\"500\" alt=\"Neofeed with cloudy-day CSS skin\" src=\"https://raw.githubusercontent.com/victoriadrake/neofeed-theme/master/images/cloudy-day-dark.png\" /\u003e\n\n## The General Idea\n\nNeofeed is an enriched Hugo theme. It gives you a fun starting point for creating your own personal feed on your own personal website! Customize as little or as much as you want and join the IndieWeb movement.\n\nStarting from scratch? Check out the [Neocities Tutorials](https://neocities.org/tutorials).\n\nYou can edit your `config.toml` to customize basic website things, like your site title, your name, and some \"about me\" text. That's all you need to deploy a great-looking Neofeed.\n\nYou can choose from pre-made CSS skins with automatic light and dark modes. Create your own to give your Neofeed personality, or share a CSS skin you made with a pull request to this repository!\n\nDay-to-day, you can deploy your own personal feed updates to your Neocities website as well as GitHub Pages with two commands.\n\n```sh\nmake entry\n# ---\n# title: 7c483a16-7931-43d7-9417-80124a06a4fa\n# date: 2021-01-03T07:03:33 \n# categories: [\"note\"]\n# tags: \n# ---\n# Hello world! Let's take back the timeline.\nmake ship\n```\n\nA special [self-documenting Makefile](https://victoria.dev/blog/how-to-create-a-self-documenting-makefile/) makes this possible. Run `make help` in the repository root to see what you can do.\n\n## Git Started\n\n### Deploy without Hugo (stand alone site)\n\nIf you have [Git](https://git-scm.com/) and [Make](https://pubs.opengroup.org/onlinepubs/9699919799/) or [GNU Make](https://www.gnu.org/software/make/), Neofeed can be set up and deployed without installing any additional dependencies.\n\n1. Fork the repository.\n2. Get your Neocities API key by going to:\n\n    `https://neocities.org/settings/{{your-sitename}}#api_key`\n3. Set up your Neocities API key as a [repository secret](https://docs.github.com/en/free-pro-team@latest/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository) called `NEOCITIES_API_TOKEN`.\n\nThen run:\n\n```sh\ngit clone https://github.com/\u003cyour username\u003e/neofeed-theme.git neofeed\ncd neofeed\n```\n\n3. Edit the `config.toml` file to name your site and choose options.\n4. Create your first entry and ship it!\n\n```sh\nmake entry\n# Write something clever in your $EDITOR\nmake ship\n```\n\nThis will build your Neofeed and deploy it to Neocities using the [included GitHub Actions workflow](https://github.com/victoriadrake/neofeed-theme/blob/master/.github/workflows/build.yaml)!\n\nYour site can also be served by Github Pages. Make it so by [configuring the publishing source](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) to be your `docs/` directory.\n\n### Use as a Hugo theme\n\n[Hugo](https://gohugo.io/) is a static site generator that helps make it easy to create a website made with plain HTML. See the [quickstart](https://gohugo.io/getting-started/quick-start/) to create your site then follow these three steps.\n\n#### 1. Add this theme\n\nAdd this theme to your Hugo site by running this command from the site's main folder:\n\n```sh\ncd \u003cwhatever you named your site folder\u003e\ngit submodule add https://github.com/victoriadrake/neofeed-theme.git\n```\n\n#### 2. Update your `config` file\n\nCopy the [exampleSite configuration file](https://github.com/victoriadrake/neofeed-theme/blob/master/exampleSite/config.toml) to your site's main folder. Update the settings as you like -- helpful comments are included.\n\nBe sure to replace `example.com` with your own domain throughout the file.\n\n#### 3. Write and deploy\n\nYou can use the `make entry` command or manually [add some content](https://gohugo.io/getting-started/quick-start/#step-4-add-some-content).\n\nWhen you're ready, you can deploy automatically with services like:\n\n- [Neocities](https://neocities.org/), either using the [included workflow](https://github.com/victoriadrake/neofeed-theme/blob/master/.github/workflows/build.yaml) or drag-and-drop upload.\n- GitHub Actions can deploy to [GitHub Pages](https://pages.github.com/) using the [included workflow](https://github.com/victoriadrake/neofeed-theme/blob/master/.github/workflows/build.yaml). Just [configure your publishing source](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) to be your `docs/` directory.\n- Other repository hosting services, like [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/) can also serve static sites.\n\n## IndieWeb Features\n\nNeofeed supports formats and protocols that encourage independent websites! To learn more about these, the community over at [IndieWebCamp](https://indieweb.org/discuss) is a great place to ask questions.\n\nHere are the features Neofeed currently supports:\n\n- Individual posts will render [Webmentions](https://www.w3.org/TR/webmention/) with support via [Webmention.io](https://webmention.io/)\n- Your posts can be automatically shared with other social media thanks to [Bridgy](https://brid.gy/) (see more about Publish (on your) Own Site, Syndicate Elsewhere [(POSSE)](https://indieweb.org/POSSE) on the IndieWebCamp wiki)\n- Your feed can be parsed by RSS and feed readers thanks to [h-card](https://microformats.org/wiki/h-card), [h-feed](https://microformats.org/wiki/h-feed), and [h-entry](https://microformats.org/wiki/h-entry) [microformats2](https://microformats.org/wiki/microformats2) markup\n- You can log into supported services using [IndieAuth](https://indieweb.org/IndieAuth) [`rel=me` links](https://indieweb.org/rel-me) (they're in the [head](https://github.com/victoriadrake/neofeed-theme/blob/master/layouts/partials/head.html) file)\n\n### Different Post Types\n\nYour posts will be displayed slightly differently depending on the `category` you put in your front matter:\n\n```text\n---\ntitle: My Awesome Post\ndate: 2021-08-05T23:01:26 \ncategories: [\"note\"] # note, reply, anything else\nreply: # If you choose \"reply\" above, the URL you're replying to\ntags: \n---\n```\n\n- If it's a `note`, just the text will show in your feed, like a tweet or microblog (this takes precedence over other categories)\n- A post with category `reply` will display a post title that links to the page you're replying to with proper [reply markup](https://microformats.org/wiki/h-entry)\n\nCheck out the example site for... examples! Just do `make demo` to see it.\n\n## Learn and Customize with Hugo\n\nIf you wish to edit the theme, create a CSS skin, or preview your timeline locally before deploying it, you'll need the [Hugo static site generator](http://gohugo.io/).\n\nYou can install the latest version by running `make gethugo`.\n\nTo see available Hugo commands, type `hugo --help`. [Hugo's searchable documentation](https://gohugo.io/documentation/) is also excellent. I recommend familiarizing yourself with Hugo's concepts using the [Quickstart](https://gohugo.io/getting-started/quick-start/).\n\n### Edit or Create a CSS Skin\n\nLook in `static/skins/` to find the CSS files that give Neofeed personality. Choose one or create your own and configure your Neofeed to use it in `config.toml`:\n\n```toml\n[params]\nskin = \"macintosh\"\n```\n\nConsider this your CSS playground! You can preview changes in your browser with [live reload](https://gohugo.io/getting-started/usage/#livereload) by running Hugo's local server with `hugo server`. See the Hugo docs for [more server options](https://gohugo.io/commands/hugo_server/).\n\nIf you create a CSS skin you'd like to share, please consider sending a pull request to add it to this repository!\n\n### Totally Optional Cool Stuff\n\nNeofeed has out-of-the-box support for these features.\n\n#### Plausible\n\nYou can set up site analytics using [Plausible](https://plausible.io/), a service that respects user privacy while still letting you see your site traffic and sources.\n\nOnce you've set up your Plausible account, just turn it on in your `config.toml`. Neofeed will use your site's URL automatically.\n\n```toml\n[params]\nplausible = true\n```\n\n#### Web Monetization\n\n[Web Monetization](https://webmonetization.org/) is a proposed standard that can let you receive micropayments when visitors browse your site. You'll need to [set up a wallet](https://webmonetization.org/docs/getting-started) that supports the Interledger Protocol (ILP).\n\nAdd your wallet's payment pointer to your `config.toml`, for example:\n\n```toml\n[params]\npaymentPointer = \"$wallet.provider.com/myspecialid123\"\n```\n\n## Contributing\n\nYou are absolutely encouraged to contribute to this friendly open source project!\n\n### Values\n\nAs a project, Neofeed has these main goals:\n\n1. Make it easy for people to ship a fun and useful website.\n2. Make it easy to participate in Neocities to encourage the creation of personal static sites.\n3. Demonstrate excellent open source community practices and repository maintenance practices.\n\nAny contribution that works towards these goals is welcome. See [CONTRIBUTING.md](https://github.com/victoriadrake/neofeed-theme/blob/master/.github/CONTRIBUTING.md) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvictoriadrake%2Fneofeed-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvictoriadrake%2Fneofeed-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvictoriadrake%2Fneofeed-theme/lists"}