{"id":18318531,"url":"https://github.com/maxmind/dev-site","last_synced_at":"2025-04-09T13:54:52.671Z","repository":{"id":37105839,"uuid":"253532107","full_name":"maxmind/dev-site","owner":"maxmind","description":"Static site generator for https://dev.maxmind.com.","archived":false,"fork":false,"pushed_at":"2025-04-07T21:17:17.000Z","size":45077,"stargazers_count":4,"open_issues_count":0,"forks_count":4,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-04-07T21:38:49.797Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maxmind.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2020-04-06T15:03:37.000Z","updated_at":"2025-04-07T21:17:20.000Z","dependencies_parsed_at":"2023-02-19T11:31:28.821Z","dependency_job_id":"805220a0-a2b2-419f-a084-5eccc6e8f93f","html_url":"https://github.com/maxmind/dev-site","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxmind%2Fdev-site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxmind%2Fdev-site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxmind%2Fdev-site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxmind%2Fdev-site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maxmind","download_url":"https://codeload.github.com/maxmind/dev-site/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248054217,"owners_count":21039951,"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":[],"created_at":"2024-11-05T18:09:54.069Z","updated_at":"2025-04-09T13:54:52.650Z","avatar_url":"https://github.com/maxmind.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003cimg\n    alt=\"MaxMind\"\n    src=\"assets/maxmind-logo.svg\"\n    width=\"300\"\n  \u003e\n  \u003cbr\u003e\n  \u003cbr\u003e\n  \u003csmall\u003eDeveloper Documentation Static Site Generator\u003c/small\u003e\n\u003c/h1\u003e\n\n---\n\n## Overview\n\n- **Static Site Generator**: [Hugo](https://gohugo.io/) +\n  [TypeScript](https://www.typescriptlang.org/) +\n- **Hosting**: [Cloudflare Pages](https://pages.cloudflare.com/)\n\n## Usage\n\n- [Minimum Requirements](#minimum-requirements)\n- [Installation](#installation)\n- [Development](#development)\n  - [Development Server](#development-server)\n- [Updating Release Notes for the New Year](#updating-release-notes-for-the-new-year)\n\n### Minimum Requirements\n\nThe minimum Node and NPM versions can be found in the\n[package.json file](package.json) under `engines`.\n\nIf you need help installing and/or managing Node and NPM versions, check out\n[NVM](https://github.com/nvm-sh/nvm).\n\n### Installation\n\n```sh\nnpm install\n```\n\n- `npm install` installs the necessary node modules for development.\n\n#### Install Precious\n\nYou should install our pre-commit hook. You can do this from your checkout\nby running `git/setup.sh`. These hooks do things like ensure that the code you\ncommit is tidy and passes various linter checks.\n\n#### Install Hugo\n\n##### Homebrew (macOS)\n\n```sh\nbrew install hugo\n```\n\n##### Debian / Ubuntu\n\nIt is recommended that you install\n[the latest release of Hugo](https://github.com/gohugoio/hugo/releases/latest).\nFor debian and ubuntu users, they offer a .deb file.\n\n##### Other OS\n\nSee [Hugo Installation](https://gohugo.io/getting-started/installing/)\n\n#### Install Embedded Dart Sass\n\nDownload\n[Embedded Dart Sass](https://github.com/sass/dart-sass-embedded/releases) and\nmake sure it is in your `$PATH`. This is necessary for Hugo to process SASS and\nSCSS files. See the\n[Hugo documentation](https://gohugo.io/hugo-pipes/scss-sass/) for more\ninformation.\n\n### Development\n\n#### Development Server\n\nThe development server watches files, rebuilds the site, and reloads the browser\nwhen files change.\n\n```sh\nhugo server\n```\n\n### Updating Release Notes for the New Year\n\nWhenever you create your first release note for a product category for a new\nyear:\n\n1. Add a file called `\u003cyear\u003e.md` to the `/content/\u003cproduct\u003e/release-notes`\n   folder. (e.g., `/content/geoip/release-notes/2024.md`) - Add the header to\n   your new release note file with the title: `\u003cProduct\u003e Release Notes` (e.g.,\n   `GeoIP2 Release Notes`) and draft to `false`. - Add the RSS notification to\n   the top of the new file.\n2. Change the `title:` field in the previous year's `md` file to read:\n   `\u003cProduct\u003e Release Notes - \u003cYear\u003e Archive` (e.g.,\n   `GeoIP2 Release Notes - 2023 Archive`) - Remove the RSS notification from the\n   top of the archived file.\n3. Update link to the release notes in the navigation menu (`hugo.toml`) to\n   point to the current year's path.\n4. Update the URLs in the redirects file (`static/_redirects`) to the current\n   year's path.\n\n### Updating Example CSVs\n\nTo do this, use the `create-example-csv-zips-for-dev-site` script in the\ninternal oneoffs repository.\n\n### Adding Page Metadata for SEO and Social Sharing\n\n#### Adding a description\n\nIn the markdown (mdx) file, add a `description` to the frontmatter located at\nthe top of the file:\n\n```md\n---\ndraft: false\ntitle: GeoIP2 is the best\ndescription: GeoIP2 is the bestest IP Intelligence product suite ever made\n---\n```\n\n#### Adding an image\n\n1. Add your image to the [static/images](static/images) directory.\n\n2. In the markdown (mdx) file, add the path to the `image` key in the\n   frontmatter located at the top of the file. **Do not include `static` to the\n   path.** For example, if your file is at `static/images/geoip2-so-cool.gif`,\n   your frontmatter would look like:\n\n```md\n---\ndraft: false\ntitle: GeoIP2 is the best\ndescription: GeoIP2 is the bestest IP Intelligence product suite ever made\nimage: /images/geoip2-so-cool.gif\n---\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxmind%2Fdev-site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaxmind%2Fdev-site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxmind%2Fdev-site/lists"}