Skip to content

Latest commit

 

History

History
129 lines (99 loc) · 3.34 KB

README.md

File metadata and controls

129 lines (99 loc) · 3.34 KB
Raw

Website

This website is built using Docusaurus 2, 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.

Add a new project

  1. Create a new markdown file and add project details, tags and descriptions here experiments/src/pages/your-project-name.md

  2. Create a new folder and add project assets(ex. logo, screenshots) here experiments/static/projects/your-project-name. Make sure you are using well optimised image files.

Project Template

---
title: Example title
description: Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took.
logo: "some_image_file.jpg"
thumbnail: "some_image_file.jpg"
gallery:
  - image: "some_image_file.jpg"
    alt: some text
  - image: "some_image_file.jpg"
    alt: some text
  - image: "some_image_file.jpg"
    alt: some text
  - image: "some_image_file.jpg"
    alt: some text
  - image: "some_image_file.jpg"
  - image: "some_image_file.jpg"
  - image: "some_image_file.jpg"
  - image: "some_image_file.jpg"
tags:
  projectStage: Hackathon Project
  event: ETH India
  winner: 1st Place
  technology:
    - Solidity
    - Python
    - Ethers.js
    - Hardhat
links:
  website:
    - "http://site.com"
  github:
    - "https://github.com/username"
  discord:
    - "http://discord.com/username"
  twitter:
    - "http://twitter.com/username"
  demo: "http://site.com/demo/"
team:
  - name: Member 1
    linkedin: "https://linkedin.com/username"
    discord: "username#1234"
    twitter: "http://twitter.com/username"
    image: "https://picsum.photos/500/500?random=1"
  - name: Member 2
    linkedin: "https://linkedin.com/username"
    discord: "username#1234"
    twitter: "http://twitter.com/username"
    image: "https://picsum.photos/500/500?random=2"
  - name: Member 3
    linkedin: "https://linkedin.com/username"
    discord: "username#1234"
    twitter: "http://twitter.com/username"
    image: "https://picsum.photos/500/500?random=3"
---

# Heading 1

Lorem Ipsum is **simply dummy** text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

## Heading 2

> Somewhere, something incredible is waiting to be known

## Heading 3

## Heading 4

## Heading 5

- List item 1
- List item 2
- List item 3

1. List item 1
2. List item 2
3. List item 3