Code Monkey home page Code Monkey logo

hydro-systems-book's Introduction

What's happening here?

This webpage contains all the code for the Hydro Systems Book available here. Here's how it works.

Markdown

Inside the src folder there are a bunch of Markdown files (files that end in .md). Markdown is a ubiquitious and easy to learn text format for creating rich text directly from a plain text file. In fact, this README.md is written in Markdown. You can view the raw text file that generates these effects here. Spme useful resources to learn Markdown.

  • A very brief summary of the Markdown format, just enough to get writing.
  • A full tutorial of Markdown.
  • A longer cheat sheet with the syntax for things like tables!
  • Google / ChatGPT is always your friend if you're unsure of the Markdown syntax for something.

mdBook

So how do these markdown files get assembled into a book? For this we use mdBook() a convenient library that provides a command line utility (downloadable here) to generate a website from the .md files. Run mdbook serve to turn on the website locally and have it update as you write. When you upload ("push") your changes to this online repository, the live website will automatically be updated (re-"built").

The documentation for mdBook is great and provides information on e.g. how to create new chapters.

Steps to make edits to the book

  1. Install Git.
  2. Clone this repository by running git clone https://github.com/staadecker/hydro-systems-book. This will download the latest version to your local computer.
  3. Write the book! I.e. make edits to the Markdown (.md) files in the src folder.
  4. Save ("commit") your changes with git commit -a -m "Some message describing the change"
  5. Upload ("push") your changes with git push. This will only work if you have write access permissions to the repository. (Those who don't can "fork" the repository, push their changes to their fork, and open a "pull request" to request that their changes get integrated into the main version).

To-do List

  • Find a better title than "Hydro Systems"
  • Choose a license for the book
  • Update the information in book.toml to ensure the metadata like the authors, book description, etc. are correct.
  • Build some interactive stuff!

hydro-systems-book's People

Contributors

staadecker avatar karneybr avatar

Watchers

 avatar

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.