config.toml

baseURL = "https://docs.ipfs.io"
relativeURLs = true
languageCode = "en"
DefaultContentLanguage = "en"
title = "IPFS Documentation"
staticDir = ["static", "build"]
googleAnalytics = "UA-96910779-6"

[privacy]
  [privacy.googleAnalytics]
    anonymizeIP = true
    respectDoNotTrack = true

[blackfriday]
hrefTargetBlank = true

[params]
editURL = "https://github.com/ipfs/docs/tree/master/content/"
ordersectionsby = "weight" # ordersectionsby = "title"

[outputs]
home = [ "HTML", "RSS", "JSON"]

[menu]

[[menu.main]]
identifier = "introduction"
name = "Introduction"
weight = 1

[[menu.main]]
identifier = "guides"
name = "Guides"
weight = 2

[[menu.main]]
identifier = "reference"
name = "Reference"
weight = 3

[[menu.main]]
identifier = "community"
name = "Community"
weight = 4


[[menu.guides]]
identifier = "guides"
name = "Guides"
weight = 3
[[menu.guides]]
parent = "guides"
name = "Transferring a File"
url = "https://github.com/ipfs/go-ipfs/blob/master/docs/file-transfer.md"
weight = 2
[[menu.guides]]
parent = "guides"
name = "Replicating Large Datasets"
url = "https://github.com/ipfs/archives/tree/master/tutorials/replicating-large-datasets"
weight = 3
[[menu.guides]]
parent = "guides"
name = "Addressing in Browsers"
url = "https://github.com/ipfs/in-web-browsers/blob/master/ADDRESSING.md"
weight = 4
[[menu.guides]]
parent = "guides"
name = "Interactive Tutorials"
url = "https://proto.school/#/tutorials"
weight = 5


[[menu.guides]]
identifier = "examples"
name = "Examples"
weight = 4
[[menu.guides]]
parent = "examples"
name = "js-ipfs Examples"
url = "https://github.com/ipfs/js-ipfs/tree/master/examples"


[[menu.reference]]
identifier = "api"
name = "Commands & API"
weight = 4
[[menu.reference]]
parent = "api"
name = "JS Core API"
url = "https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC"
weight = 30

[[menu.reference]]
identifier = "go_implementation"
name = "Go Implementation"
weight = 5
[[menu.reference]]
parent = "go_implementation"
name = "go-ipfs Core API"
url = "/go/pkg/go-ipfs/core/coreapi"
weight = 10
[[menu.reference]]
parent = "go_implementation"
name = "go-ipfs Coreiface API"
url = "/go/pkg/go-ipfs/core/coreapi/interface"
weight = 11
[[menu.reference]]
parent = "go_implementation"
name = "go-ipfs Core options API"
url = "/go/pkg/go-ipfs/core/coreapi/interface/options"
weight = 12
[[menu.reference]]
parent = "go_implementation"
name = "go-ipfs-api Reference"
url = "/go/pkg/go-ipfs-api"
weight = 30

[[menu.reference]]
identifier = "js_implementation"
name = "JS Implementation"
weight = 5
[[menu.reference]]
parent = "js_implementation"
name = "js-ipfs"
url = "https://github.com/ipfs/js-ipfs"
weight = 10
[[menu.reference]]
parent = "js_implementation"
name = "js-ipfs-api"
url = "https://github.com/ipfs/js-ipfs-api"
weight = 20

[[menu.reference]]
identifier = "specs"
name = "Specifications & Planning"
weight = 6
[[menu.reference]]
parent = "specs"
name = "IPFS Whitepaper"
url = "https://github.com/ipfs/ipfs/blob/master/papers/ipfs-cap2pfs/ipfs-p2p-file-system.pdf"
weight = 10
[[menu.reference]]
parent = "specs"
name = "IPFS Specifications"
url = "https://github.com/ipfs/specs"
weight = 20
[[menu.reference]]
parent = "specs"
name = "Roadmap to 1.0.0"
url = "https://github.com/ipfs/ipfs/blob/master/REQUIREMENTS.md"
weight = 30
[[menu.reference]]
parent = "specs"
name = "Implementation Status"
url = "https://github.com/ipfs/ipfs/blob/master/IMPLEMENTATION_STATUS.md"
weight = 40
[[menu.reference]]
parent = "specs"
name = "RFC List"
title = "“Requests for Changes” (RFC) are proposals for major modifications to protocols, library interfaces, and community processes."
url = "https://github.com/ipfs/rfcs"
weight = 50


[[menu.community]]
identifier = "applications"
name = "Applications"
weight = 8
[[menu.community]]
parent = "applications"
name = "IPFS Cluster"
title = "Manage a cluster of IPFS nodes across several machines to pool storage resources."
url = "http://cluster.ipfs.io"
weight = 10
[[menu.community]]
parent = "applications"
name = "IPFS Desktop"
title = "A cross-platform GUI application for running an IPFS node."
url = "https://github.com/ipfs-shipyard/ipfs-desktop"
weight = 20
[[menu.community]]
parent = "applications"
name = "IPFS Companion"
title = "A browser extension that makes IPFS resources securly available to web pages."
url = "https://github.com/ipfs-shipyard/ipfs-companion"
weight = 30
[[menu.community]]
parent = "applications"
name = "IPFS Pack"
title = "Package large data collections into a standard format that works well on IPFS."
url = "https://github.com/ipfs/ipfs-pack"
weight = 40

[[menu.community]]
identifier = "community"
name = "Community"
weight = 9
[[menu.community]]
parent = "community"
name = "Discussion/Support Forum"
url = "https://discuss.ipfs.io/"
weight = 10
[[menu.community]]
parent = "community"
name = "IRC"
url = "/community/irc/"
weight = 20
[[menu.community]]
parent = "community"
name = "Research Discussion"
url = "https://github.com/ipfs/notes"
weight = 30
[[menu.community]]
parent = "community"
name = "Events Calendar"
url = "https://calendar.google.com/calendar/embed?src=ipfs.io_eal36ugu5e75s207gfjcu0ae84@group.calendar.google.com"
weight = 40
[[menu.community]]
parent = "community"
name = "Community Tools"
url = "https://github.com/ipfs/community/"
weight = 50
[[menu.community]]
parent = "community"
name = "Project Management"
url = "https://github.com/ipfs/pm/"
weight = 60
[[menu.community]]
parent = "community"
name = "Blog"
url = "https://ipfs.io/blog/"
weight = 70
[[menu.community]]
parent = "community"
name = "Youtube"
url = "https://www.youtube.com/channel/UCdjsUXJ3QawK4O5L1kqqsew"
weight = 80
[[menu.community]]
parent = "community"
name = "Twitter (@IPFSbot)"
url = "https://twitter.com/IPFSbot"
weight = 90
[[menu.community]]
parent = "community"
name = "Awesome IPFS"
url = "https://awesome.ipfs.io/"
[[menu.community]]
parent = "community"
name = "Public Archives on IPFS"
title = "A community project to host archives of valuable public data."
url = "https://awesome.ipfs.io/datasets/"
[[menu.community]]
parent="community"
name = "FAQ"
url = "https://discuss.ipfs.io/c/help/Old-FAQ"

[[menu.community]]
identifier = "contribute"
name = "Get Involved"
weight = 10
[[menu.community]]
parent = "contribute"
name = "GitHub (IPFS)"
url = "https://github.com/ipfs/ipfs"
weight = 10
[[menu.community]]
parent = "contribute"
name = "GitHub (docs)"
url = "https://github.com/ipfs/docs"
weight = 20
[[menu.community]]
parent = "contribute"
name = "Contribution Guidelines"
url = "https://github.com/ipfs/community/blob/master/CONTRIBUTING.md"
weight = 30
[[menu.community]]
parent = "contribute"
name = "Code of Conduct"
url = "https://github.com/ipfs/community/blob/master/code-of-conduct.md"
weight = 40
[[menu.community]]
parent = "contribute"
name = "Go Style Guide"
url = "https://github.com/ipfs/community/blob/master/CONTRIBUTING_GO.md"
weight = 50
[[menu.community]]
parent = "contribute"
name = "JS Style Guide"
url = "https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md"
weight = 60

[[menu.community]]
identifier = "related"
name = "Related Projects"
[[menu.community]]
parent = "related"
name = "Libp2p"
url = "http://libp2p.io"
weight = 1
[[menu.community]]
parent = "related"
name = "Multiformats"
url = "https://multiformats.io"
weight = 2
[[menu.community]]
parent = "related"
name = "IPLD"
url = "https://ipld.io"
weight = 3
[[menu.community]]
parent = "related"
name = "ProtoSchool"
url = "https://proto.school/"