Add website #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft

eyeinsky wants to merge 26 commits into main from website

website/.gitignore

-Original file line number
+Diff line change
@@ -0,0 +1,22 @@
+    # Dependencies
+    /node_modules
+    # Production
+    /build
+    # Generated files
+    .docusaurus
+    .cache-loader
+    # Misc
+    .DS_Store
+    .env.local
+    .env.development.local
+    .env.test.local
+    .env.production.local
+    npm-debug.log*
+    yarn-debug.log*
+    yarn-error.log*
+    /static/haddock

website/README.md

-Original file line number
+Diff line change
@@ -0,0 +1,41 @@
+    # Website
+    This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+    ### Installation
+    ```
+    $ yarn
+    ```
+    ### Local Development
+    ```
+    $ yarn start
+    ```
+    This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+    ### Build
+    ```
+    $ yarn build
+    ```
+    This command generates static content into the `build` directory and can be served using any static contents hosting service.
+    ### Deployment
+    Using SSH:
+    ```
+    $ USE_SSH=true yarn deploy
+    ```
+    Not using SSH:
+    ```
+    $ GIT_USER=<Your GitHub username> yarn deploy
+    ```
+    If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

website/babel.config.js

-Original file line number
+Diff line change
@@ -0,0 +1,3 @@
+    module.exports = {
+      presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+    };

website/blog/2019-05-28-first-blog-post.md

-Original file line number
+Diff line change
@@ -0,0 +1,12 @@
+    ---
+    slug: first-blog-post
+    title: First Blog Post
+    authors:
+      name: Gao Wei
+      title: Docusaurus Core Team
+      url: https://github.com/wgao19
+      image_url: https://github.com/wgao19.png
+    tags: [hola, docusaurus]
+    ---
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

website/blog/2019-05-29-long-blog-post.md

-Original file line number
+Diff line change
@@ -0,0 +1,44 @@
+    ---
+    slug: long-blog-post
+    title: Long Blog Post
+    authors: endi
+    tags: [hello, docusaurus]
+    ---
+    This is the summary of a very long blog post,
+    Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
+    <!--truncate-->
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

website/blog/2021-08-01-mdx-blog-post.mdx

-Original file line number
+Diff line change
@@ -0,0 +1,20 @@
+    ---
+    slug: mdx-blog-post
+    title: MDX Blog Post
+    authors: [slorber]
+    tags: [docusaurus]
+    ---
+    Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
+    :::tip
+    Use the power of React to create interactive blog posts.
+    ```js
+    <button onClick={() => alert('button clicked!')}>Click me!</button>
+    ```
+    <button onClick={() => alert('button clicked!')}>Click me!</button>
+    :::

website/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg

Sorry, something went wrong. Reload?

Sorry, we cannot display this file.

Sorry, this file is invalid so it cannot be displayed.

website/blog/2021-08-26-welcome/index.md

-Original file line number
+Diff line change
@@ -0,0 +1,25 @@
+    ---
+    slug: welcome
+    title: Welcome
+    authors: [slorber, yangshun]
+    tags: [facebook, hello, docusaurus]
+    ---
+    [Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
+    Simply add Markdown files (or folders) to the `blog` directory.
+    Regular blog authors can be added to `authors.yml`.
+    The blog post date can be extracted from filenames, such as:
+    - `2019-05-30-welcome.md`
+    - `2019-05-30-welcome/index.md`
+    A blog post folder can be convenient to co-locate blog post images:
+    ![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)
+    The blog supports tags as well!
+    **And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.

website/blog/authors.yml

-Original file line number
+Diff line change
@@ -0,0 +1,17 @@
+    endi:
+      name: Endilie Yacop Sucipto
+      title: Maintainer of Docusaurus
+      url: https://github.com/endiliey
+      image_url: https://github.com/endiliey.png
+    yangshun:
+      name: Yangshun Tay
+      title: Front End Engineer @ Facebook
+      url: https://github.com/yangshun
+      image_url: https://github.com/yangshun.png
+    slorber:
+      name: Sébastien Lorber
+      title: Docusaurus maintainer
+      url: https://sebastienlorber.com
+      image_url: https://github.com/slorber.png

website/docs/cli.md

-Original file line number
+Diff line change
@@ -0,0 +1,44 @@
+    ---
+    sidebar_position: 10
+    ---
+    # Configuration & CLI
+    ## Chainsync
+    ```
+    -s,--socket-path ARG     Path to node socket.
+    --mainnet                Use the mainnet magic id.
+    --testnet-magic NATURAL  Specify a testnet magic id.
+    -c,--node-config ARG     Path to node configuration.
+    ```
+    ## General
+    --log-severity
+    ## Performance tuning
+    Batching:
+    ```
+    --pipeline-size
+    --batch-size
+    ```
+    Profiling:
+    ```
+    --profile
+    --profile-sample-rate
+    --profile-outfile
+    --profile-comment
+    ```
+    Parallelism:
+    ```
+    --parallel
+    --interval-length
+    --max-threads
+    --only-print-intervals
+    --no-parallelism,--no-threading
+    ```

website/docs/development/_category_.json

-Original file line number
+Diff line change
@@ -0,0 +1,8 @@
+    {
+      "label": "Development",
+      "position": 40,
+      "link": {
+        "type": "generated-index",
+        "description": " "
+      }
+    }

website/docs/development/development-environment.md

-Original file line number
+Diff line change
@@ -0,0 +1,19 @@
+    ---
+    sidebar_position: 4
+    ---
+    # Development environment
+    Mafoc depends is written in Haskell, uses Nix and Cabal, and depends on
+    [cardano-api](https://github.com/input-output-hk/cardano-api) library
+    for acquiring a local chainsync connection and extracting specific
+    data from blocks.
+    Enter development environment with
+    ```
+    git clone https://github.com/eyeinsky/mafoc
+    cd mafoc
+    nix develop
+    ```
+    All regular Cabal commands such as (`build`, `test`, `clean` etc) now work.

website/docs/development/module-structure.md

-Original file line number
+Diff line change
@@ -0,0 +1,6 @@
+    # Module structure
+    ![Module structure](./module-structure.svg)
+    If the image shows up small, right click and "open image in new tab"
+    allows for better zoom.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add website #3

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Add website #3

Are you sure you want to change the base?

Uh oh!

Add website #3

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!