diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..bebe4e0 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,33 @@ +# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs + +name: Deploy VitePress site to Pages + +on: + push: + branches: ["main"] + pull_request: + branches: ["main"] + +jobs: + build: + runs-on: ubuntu-latest + + strategy: + matrix: + node-version: [18.x] + + steps: + - uses: actions/checkout@v3 + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v3 + with: + node-version: ${{ matrix.node-version }} + cache: "npm" + - run: npm ci + - run: npm run docs:build + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: .vitepress/dist diff --git a/.gitignore b/.gitignore index e857f83..ba85447 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ .* !.gitignore +!.github !.vitepress .vitepress/dist .vitepress/cache diff --git a/README.md b/README.md index 19420b7..7db2b61 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,10 @@ *This guide is still under active development.* -## TODO +I made this guide for biologists with moderate programming experience who want to improve the way they work. You'll learn how to organize your projects, use remote resources, create reproducible software environments, and build computational pipelines. + +This guide was made with members of the [Bloom lab](https://jbloomlab.org/) in mind. In the future, I might expand this resource to apply to a more general audience. -- Copy editing each section -- Add more specific examples -- Host the website - ## Developing To develop **Bench to Byte**, you'll need to set up a few things. Specifically, you'll need two pieces of software: `Node.js` and `npm`. `Node.js` is an environment that allows you to run Javascript code on your computer. `npm` is a package manager that handles the Javascript libraries necessary to create this website.