{"id":14956153,"url":"https://github.com/ipfs/ipfs-docs","last_synced_at":"2025-04-13T21:32:48.515Z","repository":{"id":37522639,"uuid":"217073690","full_name":"ipfs/ipfs-docs","owner":"ipfs","description":"📚IPFS documentation platform","archived":false,"fork":false,"pushed_at":"2025-04-10T22:44:41.000Z","size":71586,"stargazers_count":308,"open_issues_count":41,"forks_count":432,"subscribers_count":23,"default_branch":"main","last_synced_at":"2025-04-10T23:22:04.391Z","etag":null,"topics":["bounties","hacktoberfest","ipfs","ipfs-docs"],"latest_commit_sha":null,"homepage":"https://docs.ipfs.tech","language":"Go","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/ipfs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2019-10-23T14:09:51.000Z","updated_at":"2025-04-04T02:15:59.000Z","dependencies_parsed_at":"2025-04-02T12:32:56.973Z","dependency_job_id":null,"html_url":"https://github.com/ipfs/ipfs-docs","commit_stats":{"total_commits":2591,"total_committers":209,"mean_commits":"12.397129186602871","dds":0.8104978772674643,"last_synced_commit":"40a51d4db1a64d6ad5de99ffdd4bafcdfd659ab4"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs%2Fipfs-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs%2Fipfs-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs%2Fipfs-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs%2Fipfs-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ipfs","download_url":"https://codeload.github.com/ipfs/ipfs-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248323083,"owners_count":21084435,"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":["bounties","hacktoberfest","ipfs","ipfs-docs"],"created_at":"2024-09-24T13:12:23.700Z","updated_at":"2025-04-13T21:32:43.494Z","avatar_url":"https://github.com/ipfs.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003cimg align=\"center\" src=\"./images/ipfs-docs-header.png\" width=\"1000\"\u003e\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n\u003ch3\u003e IPFS is an open system to manage data without a central server \u003c/h3\u003e\n\u003cbr\u003e\n\n[![Made by icon.](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai/)\n[![Project icon.](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.tech/)\n[![Build status icon.](https://img.shields.io/circleci/project/github/ipfs/ipfs-docs/master.svg?style=flat-square)](https://circleci.com/gh/ipfs/ipfs-docs)\n![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)\n\u003c/div\u003e\n\n\u003c!-- TOC --\u003e\n- [Project set up](#project-set-up)\n  - [Run locally](#run-locally)\n  - [Troubleshooting](#troubleshooting)\n    - [Digital envelope routines initialization error](#digital-envelope-routines-initialization-error)\n- [Contribute to documentation](#contribute-to-documentation)\n  - [Issues](#issues)\n  - [Bounties](#bounties)\n  - [Suggestions](#suggestions)\n  - [Pull requests welcome](#pull-requests-welcome)\n- [Style and configuration guide](#style-and-configuration-guide)\n  - [Static-site generator](#static-site-generator)\n  - [Automated deployments](#automated-deployments)\n  - [Translation](#translation)\n- [Primary maintainers](#primary-maintainers)\n- [License](#license)\n\u003c!-- /TOC --\u003e\n\n---\n\nWelcome to the official IPFS documentation. The Interplanetary File System (IPFS) is a distributed, peer-to-peer network for storing and accessing files, websites, applications, and data. Protocol Labs is the primary maintainer of the IPFS documentation and will review all issues and pull requests created in this repository.\n\n**If you'd just like to read the IPFS documentation, we recommend the [website version](https://docs.ipfs.tech).**\n\n## Project set up\n\n### Run locally\n\nTo build the site locally, follow the steps below.\n\n1. Clone this repository:\n\n   ```bash\n   git clone https://github.com/ipfs/ipfs-docs.git\n   ```\n\n1. Move into the `ipfs-docs` folder:\n\n   ```bash\n   cd ipfs-docs\n   ```\n   \n1. Install the NPM dependencies:\n\n   ```bash\n   npm install\n   ```\n\n1. Boot up the application in _dev mode_:\n\n   ```bash\n   npm start\n   ```\n\n1. Open [localhost:8080](http://localhost:8080) in your browser.\n1. Close the local server with `CTRL` + `c`.\n1. To restart the local server, run `npm start` from within the `ipfs-docs` folder.\n\n### Troubleshooting\n\nIf you're having trouble setting up the site locally, check this section for solutions to common issues.\n\n#### Digital envelope routines initialization error\n\nThe following error message may display when using Node.js version 18.0.0 when attempting to deploy this project for the first time:\n\n   ```shell\n   opensslErrorStack: [ 'error:03000086:digital envelope routines::initialization error' ],\n   library: 'digital envelope routines',\n   reason: 'unsupported',\n   code: 'ERR_OSSL_EVP_UNSUPPORTED'\n   ```\n\nTo solve this error, perform the following steps:\n\n1. Open a terminal.\n2. Navigate into the `ipfs-docs` folder:\n\n   ```bash\n   cd ipfs-docs\n   ```\n\n3. Run the following command:\n\n   ```shell\n    export NODE_OPTIONS=--openssl-legacy-provider\n   ```\n\n4. Run `npm start`.\n\n   ```bash\n   npm start\n   ```\n\nYou can return to the [Project set-up](#project-set-up) section above and continue with the steps. You can also check [this issue in the Webpack GitHub repository](https://github.com/webpack/webpack/issues/14532) for more information about this error.\n\n## Contribute to documentation\n\nWe would **love ❤️ your help** to improve existing items or make new ones even better! [We also have bounties available](https://github.com/ipfs/devgrants/projects/1)!\n\n### Issues\n\nIf you find something wrong within this repository, please raise an issue [here →](https://github.com/ipfs/ipfs-docs/issues). Unless the issue is urgent, updates will be batch-merged into `main` on Tuesdays or Thursdays.\n\n### Bounties\n\nYou can earn the undying love of the IPFS community, _and_ get rewarded by closing an issue containing the [`bounty` tag](https://github.com/ipfs/ipfs-docs/issues?q=is%3Aopen+is%3Aissue+label%3Abounty). Submissions must be production-ready and meet all the specifications listed on the issue page. To get started, check out the [current list of open bounties →](https://github.com/ipfs/devgrants/projects/1).\n\nIf you are attempting to close an issue, great! Thanks for the help! Please leave a comment within the issue requesting to be assigned to that issue **before** submitting a pull request. This minimizes the chance of multiple contributors duplicating work by submitting pull requests for the same issue. If you submit a pull request to an issue _without_ first being assigned to it, your pull request may not be accepted.\n\n### Suggestions\n\nEveryone has an opinion when it comes to documentation, and **that's a good thing**! Having folks from different backgrounds add to a discussion empowers everyone within that discussion, so if you've got something to add or would like to bring up a topic for discussion about the documentation, please do so! Create an issue using the [`kind/question` tag](https://github.com/ipfs/ipfs-docs/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fquestion).\n\n### Pull requests welcome\n\nFeel free to submit pull requests with any changes you'd like to see. We will review and approve, or leave change requests, as soon as we are able.\n\n## Style and configuration guide\n\nA writing style and template guide is in the process of being written that contributors can use as a guideline.\n\n### Static-site generator\n\nThe IPFS documentation site uses the [VuePress static website generator](https://vuepress.vuejs.org/) to convert the Markdown guides into a documentation website. All the documentation is written in Markdown; follow the [VuePress Markdown documentation](https://vuepress.github.io/guide/markdown.html) for information on how to write markdown files for VuePress.\n\n### Automated deployments\n\nWhen opening a pull request, CI scripts will run against your feature branch to test your changes.\n\nThe CI/CD production workflow builds on the `main` branch and deploys the documentation site on [fleek](https://fleek.co/). The site reflects the latest commit on `main`.\n\n## Primary maintainers\n\n- [@2color](https://github.com/2color): Developer relations \u0026 technical writing(ecosystem)\n\n## License\n\nAll software code is copyright (c) Protocol Labs, Inc. under the **MIT license**. Other written documentation and content are copyright (c) Protocol Labs, Inc. under the [**Creative Commons Attribution-Share-Alike License**](https://creativecommons.org/licenses/by/4.0/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fipfs%2Fipfs-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fipfs%2Fipfs-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fipfs%2Fipfs-docs/lists"}