This repository manages the documentation for the Filecoin network. This repo also contains the build scripts and tools to create the Filecoin docs website. Explore the docs →
Follow these simple example steps to get a local version of the site up and running.
To run these commands, you must have NPM installed. If you already have NPM installed, make sure you are running the latest version:
npm install npm@latest -gFollow these steps to run a copy of this site on your local computer.
-
Clone this repo:
git clone https://github.com/filecoin-project/filecoin-docs
-
Move into the new folder and download the dependencies:
cd filecoin-docs npm install -
Build the project and serve it locally using Hugo's built-in server:
npm run build
-
Visit localhost:1313 to view the site.
-
Press
CTRL+cin the terminal to stop the local server.
This repository manages the documentation for the Filecoin project. This repo also contains the build scripts and tools to create the Filecoin docs website and the API documentation. If you want to learn about Filecoin, how it works, or how to build on it, then you're in the right place.
This section lists the various files and folders and defines the purpose for each of them.
| Name | Purpose |
|---|---|
.git, .github |
Manage the git configurations and contain information for GitHub constant integrations. |
README.md |
This file. Acts as an introduction to this repo and how to spin up a local copy of the docs.filecoin.io site. |
archetypes/ |
Used by Hugo to programmatically create new pages. |
assets/ |
Assets like JavaScript and fonts used by Hugo to create the static site. These assets are not explorable in a built site. You must reference them in code before building the site. |
babel.config.js |
A configuration file used for the Babel JS compiler. |
config/ |
Contains the configuration files for Hugo. You can manage things like the top-bar menu and site title within this directory. |
content/ |
This is where all the .md files live that control the content of this site. Most contributions happen in this directory. |
data/ |
You can supply extra variables for Hugo to use when building pages in this directory. These variables act just like front-matter variables. See Data Templates in the Hugo docs for more info. |
functions/ |
Functions callable from any template, partial, or shortcode within Hugo. |
i18n/ |
Contains files specific to managing different languages. |
layouts/ |
This is where web developers will likely spend most of their time. This folder contains the shortcodes and partials that Hugo uses to scaffold and build the site. |
node_modules/ |
Where NPM throws its packages. If you see this in GitHub, something's gone wrong. It should only exist on your computer after you run npm install. |
package-lock.json |
One of the NPM configuration files. Specify which version of packages to download. |
package.json |
Another one of the NPM configuration files. Specifies which packages to download but doesn't specify which version of the package to grab. |
resources/ |
A cache where Hugo throws generated files like CSS and JSON after npm run build has been called. Unless npm run clean is called, Hugo will re-use these files when calling npm run build. |
static/ |
Images, CSS, fonts, and other misc files available at docs.filecoin.io/ when the site is built. For example, docs.filecoin.io/site.webmanifest. |
theme.toml |
A Hugo configuration file that specifies which theme to use. This file should not change that often. |
Want to help out? Pull requests (PRs) are always welcome! If you want to help out but aren't sure where to start, check out the issues board.
Here's a collection of guides you can use to help manage and contribute to this site:
Found a problem with the Filecoin docs site? Please raise an issue. Be as specific and descriptive as possible; screenshots help!
Dual-licensed: MIT, Apache Software License v2, by way of the Permissive License Stack.