Giter Club home page Giter Club logo

flashbots-writings-website's Introduction

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

Install the node packages from within a Docker container (strongly recommended not only for security, but because installing all the packages manually is a huge waste of time), then you can start it like this:

docker run -p 3000:3000 --rm -it -w /mnt -v $(pwd):/mnt node:16 /bin/bash

Install the dependencies:

$ yarn

Local Development

Build the source:

$ source .env.dev
$ 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. You can view it now at:

http://localhost:3000

Deployment

Changed to the main branch are automatically deployed by CI.

Steps to publish a new post

  1. clone the repository https://github.com/flashbots/flashbots-writings-website and switch to a new branch
  2. copy one of the files in /content/ with the date and your title (for instance, start with this post)
  3. edit the content on the header. for SEO and previews/sharing, it is recommended to add an image. You can get free images from https://unsplash.com and other pages, but also consider generating an image with Dall-E and Stable Diffusion. Try to make the image less than 200kb.
  4. edit the content of the post. To preview, install the dependencies as described above and run yarn start
  5. once satisfied, create a PR. once merged CI auto deploys it (edited)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.