4 |
5 | ---
6 |
7 | # Dat Project Documentation
8 |
--------------------------------------------------------------------------------
/docs-dat/learn-more-dat-protocol.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: dat-protocol
3 | title: More About the Hypercore Protocol
4 | sidebar_label: The Hypercore Protocol
5 | ---
6 |
7 | Hypercore Protocol is a protocol for sharing data between computers.
8 |
9 | The *Dat Project* helps shepherd community efforts surrounding the Hypercore Protocol.
10 | Find more information about the specifications, Hypercore Protocol working group, and Dat governance:
11 |
12 | * [Hypercore Protocol Specifications](https://hypercore-protocol.org/)
13 | * [Governance](https://github.com/datproject/governance)
14 | * [How Dat Works](https://dat-ecosystem-archive.github.io/how-dat-works/) (outdated)
15 |
--------------------------------------------------------------------------------
/docs/js/codetabs.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2017-present, Facebook, Inc.
3 | *
4 | * This source code is licensed under the MIT license found in the
5 | * LICENSE file in the root directory of this source tree.
6 | */
7 |
8 | // Turn off ESLint for this file because it's sent down to users as-is.
9 | /* eslint-disable */
10 | window.addEventListener('load', function() {
11 | // add event listener for all tab
12 | document.querySelectorAll('.nav-link').forEach(function(el) {
13 | el.addEventListener('click', function(e) {
14 | const groupId = e.target.getAttribute('data-group');
15 | document
16 | .querySelectorAll(`.nav-link[data-group=${groupId}]`)
17 | .forEach(function(el) {
18 | el.classList.remove('active');
19 | });
20 | document
21 | .querySelectorAll(`.tab-pane[data-group=${groupId}]`)
22 | .forEach(function(el) {
23 | el.classList.remove('active');
24 | });
25 | e.target.classList.add('active');
26 | document
27 | .querySelector(`#${e.target.getAttribute('data-tab')}`)
28 | .classList.add('active');
29 | });
30 | });
31 | });
32 |
--------------------------------------------------------------------------------
/docs/img/language.svg:
--------------------------------------------------------------------------------
1 |
4 |
--------------------------------------------------------------------------------
/website/pages/en/users.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2017-present, Facebook, Inc.
3 | *
4 | * This source code is licensed under the MIT license found in the
5 | * LICENSE file in the root directory of this source tree.
6 | */
7 |
8 | const React = require('react');
9 |
10 | const CompLibrary = require('../../core/CompLibrary.js');
11 |
12 | const Container = CompLibrary.Container;
13 |
14 | class Users extends React.Component {
15 | render() {
16 | const {config: siteConfig} = this.props;
17 | if ((siteConfig.users || []).length === 0) {
18 | return null;
19 | }
20 |
21 | const editUrl = `${siteConfig.repoUrl}/edit/master/website/siteConfig.js`;
22 | const showcase = siteConfig.users.map(user => (
23 |
24 | This project is used by many folks
35 |Are you using this project?
38 | 39 | Add your company 40 | 41 |
29 |
30 | If your dat has an `index.html` page, that will be shown instead.
31 |
32 | You can combine Dat's http support with our server tools to create a live updating website or place to share files publicly.
33 |
34 | ## Built-in Versioning
35 |
36 | As you may know, Dat automatically versions all files.
37 | The HTTP display is an easy way to view version history:
38 |
39 | **Use `localhost:8080/?version=2` to view a specific version.**
40 |
41 | ## Live reloading
42 |
43 | The Dat http viewer also comes with live reloading.
44 | If it detects a new version it will automatically reload with the new directory listing or page (as long as you aren't viewing a specific version in the url).
45 |
46 | ## Sparse Downloading
47 |
48 | Dat supports *sparse*, or partial downloads, of datasets.
49 | This is really useful if you only want a single file from a large dat.
50 | Unfortunately, we haven't quite built a user interface for this into our applications.
51 | So you can hack around it!
52 |
53 | This will allow you to download a single file from a larger dat, without downloading metadata or any other files.
54 |
55 | First, start downloading our demo dat, make sure you include both the flags (`--http`, `--sparse`).
56 |
57 | ```
58 | ❯ dat dat://778f8d955175c92e4ced5e4f5563f69bfec0c86cc6f670352c457943666fe639 ./demo --http --sparse
59 | Cloning: 2 files (1.4 MB)
60 | Serving files over http at http://localhost:8080
61 |
62 | 3 connections | Download 0 B/s Upload 0 B/s
63 | ```
64 |
65 | The `--sparse` option tells Dat to only download files you specifically request.
66 | See how it works:
67 |
68 | 1. Check out your `./demo` folder, it should be empty.
69 | 2. Open the Dat in your browser.
70 | 3. Click on a file to download.
71 | 4. It should be in your folder now!
72 |
73 | Pretty cool! You can use this hack to download only specific files or even older versions of files (if they've been saved somewhere).
74 |
--------------------------------------------------------------------------------
/website/core/Footer.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2017-present, Facebook, Inc.
3 | *
4 | * This source code is licensed under the MIT license found in the
5 | * LICENSE file in the root directory of this source tree.
6 | */
7 |
8 | const React = require('react');
9 |
10 | class Footer extends React.Component {
11 | docUrl(doc, language) {
12 | const baseUrl = this.props.config.baseUrl;
13 | const docsUrl = this.props.config.docsUrl;
14 | const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`;
15 | const langPart = `${language ? `${language}/` : ''}`;
16 | return `${baseUrl}${docsPart}${langPart}${doc}`;
17 | }
18 |
19 | pageUrl(doc, language) {
20 | const baseUrl = this.props.config.baseUrl;
21 | return baseUrl + (language ? `${language}/` : '') + doc;
22 | }
23 |
24 | render() {
25 | return (
26 |
91 | );
92 | }
93 | }
94 |
95 | module.exports = Footer;
96 |
--------------------------------------------------------------------------------
/website/siteConfig.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2017-present, Facebook, Inc.
3 | *
4 | * This source code is licensed under the MIT license found in the
5 | * LICENSE file in the root directory of this source tree.
6 | */
7 |
8 | // See https://dat-logo-small.pngdocs/site-config for all the possible
9 | // site configuration options.
10 |
11 | // List of projects/orgs using your project for the users page.
12 | // const users = [
13 | // {
14 | // caption: 'User1',
15 | // // You will need to prepend the image path with your baseUrl
16 | // // if it is not '/', like: '/test-site/img/dat-logo-small.png'.
17 | // image: '/img/dat-logo-small.png',
18 | // infoLink: 'https://datproject.org',
19 | // pinned: true,
20 | // },
21 | // ];
22 |
23 | const siteConfig = {
24 | title: 'Dat Docs', // Title for your website.
25 | tagline: 'User Docs for the Dat Ecosystem',
26 | url: 'https://docs.datproject.org', // Your website URL
27 | baseUrl: '/', // Base URL for your project */
28 |
29 | // Used for publishing and more
30 | projectName: 'dat-docs',
31 | organizationName: 'datproject',
32 |
33 | // For no header links in the top nav bar -> headerLinks: [],
34 | headerLinks: [
35 | {doc: 'intro', label: 'Docs'},
36 | {doc: 'install', label: 'Install'},
37 | {page: 'help', label: 'Help'},
38 | {href: 'https://blog.dat-ecosystem.org', label: 'Blog'}
39 | ],
40 |
41 | // If you have users set above, you add it here:
42 | // users,
43 |
44 | /* path to images for header/footer */
45 | headerIcon: 'img/dat-logo-small.png',
46 | footerIcon: 'img/dat-logo-small.png',
47 | favicon: 'img/favicon.ico',
48 |
49 | /* Colors for website */
50 | colors: {
51 | primaryColor: '#045943',
52 | secondaryColor: '#293648',
53 | },
54 |
55 | /* Custom fonts for website */
56 | /*
57 | fonts: {
58 | myFont: [
59 | "Times New Roman",
60 | "Serif"
61 | ],
62 | myOtherFont: [
63 | "-apple-system",
64 | "system-ui"
65 | ]
66 | },
67 | */
68 |
69 | // This copyright info is used in /core/Footer.js and blog RSS/Atom feeds.
70 | copyright: `Copyright © ${new Date().getFullYear()} Dat Project Contributors`,
71 |
72 | highlight: {
73 | // Highlight.js theme to use for syntax highlighting in code blocks.
74 | theme: 'default',
75 | },
76 |
77 | // Add custom scripts here that would be placed in
20 |
21 |
22 |
23 |
24 | 
29 |