From 5054a5191f7c8cc87b5910ea68a8186933bee370 Mon Sep 17 00:00:00 2001 From: ryderdamen Date: Tue, 22 Oct 2024 20:23:54 -0400 Subject: [PATCH] update to docsify --- .github/workflows/pages.yml | 58 ++---------- .gitignore | 49 +++++++--- Gemfile | 7 -- Gemfile.lock | 91 ------------------ README.md | 177 ++---------------------------------- about.md | 18 ++++ conferences.md | 25 +++++ index.html | 25 +++++ resources.md | 34 +++++++ 9 files changed, 156 insertions(+), 328 deletions(-) delete mode 100644 Gemfile delete mode 100644 Gemfile.lock create mode 100644 about.md create mode 100644 conferences.md create mode 100644 index.html create mode 100644 resources.md diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index f175116..7911fc6 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -4,59 +4,21 @@ # documentation. # Sample workflow for building and deploying a Jekyll site to GitHub Pages -name: Deploy Jekyll site to Pages +name: Deploy to GitHub Pages on: push: - branches: ["main"] - - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: - -# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages -permissions: - contents: read - pages: write - id-token: write - -# Allow one concurrent deployment -concurrency: - group: "pages" - cancel-in-progress: true + branches: + - main jobs: - # Build job - build: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - name: Setup Ruby - uses: ruby/setup-ruby@v1 - with: - ruby-version: '3.3' # Not needed with a .ruby-version file - bundler-cache: true # runs 'bundle install' and caches installed gems automatically - cache-version: 0 # Increment this number if you need to re-download cached gems - - name: Setup Pages - id: pages - uses: actions/configure-pages@v5 - - name: Build with Jekyll - # Outputs to the './_site' directory by default - run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" - env: - JEKYLL_ENV: production - - name: Upload artifact - # Automatically uploads an artifact from the './_site' directory by default - uses: actions/upload-pages-artifact@v3 - - # Deployment job deploy: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest - needs: build steps: - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4 + - uses: actions/checkout@v2 + + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: . diff --git a/.gitignore b/.gitignore index f9f1d49..6c70066 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,40 @@ # Not sure what a .gitignore is? # See: https://git-scm.com/docs/gitignore -# These are directly copied from Jekyll's first-party docs on `.gitignore` files: -# https://jekyllrb.com/tutorials/using-jekyll-with-bundler/#commit-to-source-control - -# Ignore the default location of the built site, and caches and metadata generated by Jekyll -_site/ -.sass-cache/ -.jekyll-cache/ -.jekyll-metadata - -# Ignore folders generated by Bundler -.bundle/ -vendor/ +# Ignore system and IDE files +.DS_Store +.vscode/ + +# Node modules (if using npm for any reason) +node_modules/ + +# Docsify generated files +_sidebar.md + +# Logs +*.log + +# Environment variables +.env + +# Docker +Dockerfile +.dockerignore + +# Makefile +Makefile + +# Temporary files +*.tmp +*.swp +*.swo + +# Build output (if any) +dist/ +build/ + +# Coverage directory used by tools like istanbul +coverage/ + +# Optional: ignore local development server files +.docsify/ diff --git a/Gemfile b/Gemfile deleted file mode 100644 index 157e918..0000000 --- a/Gemfile +++ /dev/null @@ -1,7 +0,0 @@ -source 'https://rubygems.org' - -gem "jekyll", "~> 4.3.4" # installed by `gem jekyll` -# gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2 - -gem "just-the-docs", "0.10.0" # pinned to the current release -# gem "just-the-docs" # always download the latest release diff --git a/Gemfile.lock b/Gemfile.lock deleted file mode 100644 index dd64b4d..0000000 --- a/Gemfile.lock +++ /dev/null @@ -1,91 +0,0 @@ -GEM - remote: https://rubygems.org/ - specs: - addressable (2.8.7) - public_suffix (>= 2.0.2, < 7.0) - bigdecimal (3.1.8) - colorator (1.1.0) - concurrent-ruby (1.3.4) - em-websocket (0.5.3) - eventmachine (>= 0.12.9) - http_parser.rb (~> 0) - eventmachine (1.2.7) - ffi (1.17.0-arm64-darwin) - ffi (1.17.0-x86_64-linux-gnu) - forwardable-extended (2.6.0) - google-protobuf (4.28.1-arm64-darwin) - bigdecimal - rake (>= 13) - google-protobuf (4.28.1-x86_64-linux) - bigdecimal - rake (>= 13) - http_parser.rb (0.8.0) - i18n (1.14.6) - concurrent-ruby (~> 1.0) - jekyll (4.3.4) - addressable (~> 2.4) - colorator (~> 1.0) - em-websocket (~> 0.5) - i18n (~> 1.0) - jekyll-sass-converter (>= 2.0, < 4.0) - jekyll-watch (~> 2.0) - kramdown (~> 2.3, >= 2.3.1) - kramdown-parser-gfm (~> 1.0) - liquid (~> 4.0) - mercenary (>= 0.3.6, < 0.5) - pathutil (~> 0.9) - rouge (>= 3.0, < 5.0) - safe_yaml (~> 1.0) - terminal-table (>= 1.8, < 4.0) - webrick (~> 1.7) - jekyll-include-cache (0.2.1) - jekyll (>= 3.7, < 5.0) - jekyll-sass-converter (3.0.0) - sass-embedded (~> 1.54) - jekyll-seo-tag (2.8.0) - jekyll (>= 3.8, < 5.0) - jekyll-watch (2.2.1) - listen (~> 3.0) - just-the-docs (0.10.0) - jekyll (>= 3.8.5) - jekyll-include-cache - jekyll-seo-tag (>= 2.0) - rake (>= 12.3.1) - kramdown (2.4.0) - rexml - kramdown-parser-gfm (1.1.0) - kramdown (~> 2.0) - liquid (4.0.4) - listen (3.9.0) - rb-fsevent (~> 0.10, >= 0.10.3) - rb-inotify (~> 0.9, >= 0.9.10) - mercenary (0.4.0) - pathutil (0.16.2) - forwardable-extended (~> 2.6) - public_suffix (6.0.1) - rake (13.2.1) - rb-fsevent (0.11.2) - rb-inotify (0.11.1) - ffi (~> 1.0) - rexml (3.3.7) - rouge (4.3.0) - safe_yaml (1.0.5) - sass-embedded (1.78.0-arm64-darwin) - google-protobuf (~> 4.27) - sass-embedded (1.78.0-x86_64-linux-gnu) - google-protobuf (~> 4.27) - terminal-table (3.0.2) - unicode-display_width (>= 1.1.1, < 3) - unicode-display_width (2.6.0) - webrick (1.8.1) - -PLATFORMS - arm64-darwin - x86_64-linux-gnu - -DEPENDENCIES - jekyll (~> 4.3.4) - just-the-docs (= 0.10.0) - -BUNDLED WITH - 2.5.9 diff --git a/README.md b/README.md index 362efd4..7f62c13 100644 --- a/README.md +++ b/README.md @@ -1,174 +1,11 @@ -# just-the-docs-template +# Creative Technologist Resources -This is a *bare-minimum* template to create a [Jekyll] site that: +Welcome to the Creative Technologist Resources site! Here you'll find valuable information and resources for creative technologists. -- uses the [Just the Docs] theme; -- can be built and published on [GitHub Pages]; -- can be built and previewed locally, and published on other platforms. +## Navigation -More specifically, the created site: +Use the sidebar to explore different sections of the site: -- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem; -- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages. - -To get started with creating a site, simply: - -1. click "[use this template]" to create a GitHub repository -2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions - -If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](#hosting-your-docs-from-an-existing-project-repo). - -After completing the creation of your new site on GitHub, update it as needed: - -## Replace the content of the template pages - -Update the following files to your own content: - -- `index.md` (your new home page) -- `README.md` (information for those who access your site repo on GitHub) - -## Changing the version of the theme and/or Jekyll - -Simply edit the relevant line(s) in the `Gemfile`. - -## Adding a plugin - -The Just the Docs theme automatically includes the [`jekyll-seo-tag`] plugin. - -To add an extra plugin, you need to add it in the `Gemfile` *and* in `_config.yml`. For example, to add [`jekyll-default-layout`]: - -- Add the following to your site's `Gemfile`: - - ```ruby - gem "jekyll-default-layout" - ``` - -- And add the following to your site's `_config.yml`: - - ```yaml - plugins: - - jekyll-default-layout - ``` - -Note: If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`. - -## Publishing your site on GitHub Pages - -1. If your created site is `YOUR-USERNAME/YOUR-SITE-NAME`, update `_config.yml` to: - - ```yaml - title: YOUR TITLE - description: YOUR DESCRIPTION - theme: just-the-docs - - url: https://YOUR-USERNAME.github.io/YOUR-SITE-NAME - - aux_links: # remove if you don't want this link to appear on your pages - Template Repository: https://github.com/YOUR-USERNAME/YOUR-SITE-NAME - ``` - -2. Push your updated `_config.yml` to your site on GitHub. - -3. In your newly created repo on GitHub: - - go to the `Settings` tab -> `Pages` -> `Build and deployment`, then select `Source`: `GitHub Actions`. - - if there were any failed Actions, go to the `Actions` tab and click on `Re-run jobs`. - -## Building and previewing your site locally - -Assuming [Jekyll] and [Bundler] are installed on your computer: - -1. Change your working directory to the root directory of your site. - -2. Run `bundle install`. - -3. Run `bundle exec jekyll serve` to build your site and preview it at `localhost:4000`. - - The built site is stored in the directory `_site`. - -## Publishing your built site on a different platform - -Just upload all the files in the directory `_site`. - -## Customization - -You're free to customize sites that you create with this template, however you like! - -[Browse our documentation][Just the Docs] to learn more about how to use this theme. - -## Hosting your docs from an existing project repo - -You might want to maintain your docs in an existing project repo. Instead of creating a new repo using the [just-the-docs template](https://github.com/just-the-docs/just-the-docs-template), you can copy the template files into your existing repo and configure the template's Github Actions workflow to build from a `docs` directory. You can clone the template to your local machine or download the `.zip` file to access the files. - -### Copy the template files - -1. Create a `.github/workflows` directory at your project root if your repo doesn't already have one. Copy the `pages.yml` file into this directory. GitHub Actions searches this directory for workflow files. - -2. Create a `docs` directory at your project root and copy all remaining template files into this directory. - -### Modify the GitHub Actions workflow - -The GitHub Actions workflow that builds and deploys your site to Github Pages is defined by the `pages.yml` file. You'll need to edit this file to that so that your build and deploy steps look to your `docs` directory, rather than the project root. - -1. Set the default `working-directory` param for the build job. - - ```yaml - build: - runs-on: ubuntu-latest - defaults: - run: - working-directory: docs - ``` - -2. Set the `working-directory` param for the Setup Ruby step. - - ```yaml - - name: Setup Ruby - uses: ruby/setup-ruby@v1 - with: - ruby-version: '3.1' - bundler-cache: true - cache-version: 0 - working-directory: '${{ github.workspace }}/docs' - ``` - -3. Set the path param for the Upload artifact step: - - ```yaml - - name: Upload artifact - uses: actions/upload-pages-artifact@v1 - with: - path: "docs/_site/" - ``` - -4. Modify the trigger so that only changes within the `docs` directory start the workflow. Otherwise, every change to your project (even those that don't affect the docs) would trigger a new site build and deploy. - - ```yaml - on: - push: - branches: - - "main" - paths: - - "docs/**" - ``` - -## Licensing and Attribution - -This repository is licensed under the [MIT License]. You are generally free to reuse or extend upon this code as you see fit; just include the original copy of the license (which is preserved when you "make a template"). While it's not necessary, we'd love to hear from you if you do use this template, and how we can improve it for future use! - -The deployment GitHub Actions workflow is heavily based on GitHub's mixed-party [starter workflows]. A copy of their MIT License is available in [actions/starter-workflows]. - ----- - -[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site). - -[Jekyll]: https://jekyllrb.com -[Just the Docs]: https://just-the-docs.github.io/just-the-docs/ -[GitHub Pages]: https://docs.github.com/en/pages -[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/ -[Bundler]: https://bundler.io -[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate -[`jekyll-default-layout`]: https://github.com/benbalter/jekyll-default-layout -[`jekyll-seo-tag`]: https://jekyll.github.io/jekyll-seo-tag -[MIT License]: https://en.wikipedia.org/wiki/MIT_License -[starter workflows]: https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml -[actions/starter-workflows]: https://github.com/actions/starter-workflows/blob/main/LICENSE +- [About](about.md): Learn more about creative technology and this resource. +- [Conferences](conferences.md): Find information about relevant conferences and events. +- [Resources](resources.md): Discover tools, tutorials, and other helpful resources. diff --git a/about.md b/about.md new file mode 100644 index 0000000..8a448e6 --- /dev/null +++ b/about.md @@ -0,0 +1,18 @@ +# About Creative Technology + +Creative technology is an interdisciplinary field that combines creativity, design, and technology to create innovative solutions and experiences. This resource aims to provide valuable information for those working in or interested in this exciting field. + +## What is a Creative Technologist? + +A creative technologist is a professional who bridges the gap between creative concepts and technical implementation. They often work in fields such as: + +- Interactive media +- Digital art +- User experience design +- Immersive technologies (AR/VR) +- Internet of Things (IoT) +- And more! + +## About This Resource + +This site is designed to be a comprehensive resource for creative technologists, providing information on conferences, tools, tutorials, and other valuable resources to help you stay up-to-date and inspired in this rapidly evolving field. diff --git a/conferences.md b/conferences.md new file mode 100644 index 0000000..ba7cd71 --- /dev/null +++ b/conferences.md @@ -0,0 +1,25 @@ +# Conferences for Creative Technologists + +Stay updated with the latest trends and network with fellow professionals by attending these conferences: + +1. **SIGGRAPH** + - Focus: Computer graphics and interactive techniques + - Website: [https://www.siggraph.org/](https://www.siggraph.org/) + +2. **Ars Electronica Festival** + - Focus: Art, technology, and society + - Website: [https://ars.electronica.art/](https://ars.electronica.art/) + +3. **Eyeo Festival** + - Focus: Creativity and technology + - Website: [http://eyeofestival.com/](http://eyeofestival.com/) + +4. **Resonate Festival** + - Focus: Art and technology + - Website: [https://resonate.io/](https://resonate.io/) + +5. **KIKK Festival** + - Focus: Digital and creative cultures + - Website: [https://www.kikk.be/](https://www.kikk.be/) + +Remember to check the official websites for the most up-to-date information on dates, locations, and ticket availability. diff --git a/index.html b/index.html new file mode 100644 index 0000000..f8bb3b7 --- /dev/null +++ b/index.html @@ -0,0 +1,25 @@ + + + + + Creative Technologist Resources + + + + + + +
+ + + + + diff --git a/resources.md b/resources.md new file mode 100644 index 0000000..bdad15c --- /dev/null +++ b/resources.md @@ -0,0 +1,34 @@ +# Resources for Creative Technologists + +Here's a curated list of resources to help you in your creative technology journey: + +## Learning Platforms + +1. [Coursera](https://www.coursera.org/) +2. [Udacity](https://www.udacity.com/) +3. [edX](https://www.edx.org/) +4. [FutureLearn](https://www.futurelearn.com/) + +## Tools and Software + +1. [Processing](https://processing.org/) - For creative coding +2. [p5.js](https://p5js.org/) - JavaScript library for creative coding +3. [Unity](https://unity.com/) - Game engine and interactive 3D +4. [Arduino](https://www.arduino.cc/) - Open-source electronics platform +5. [TouchDesigner](https://derivative.ca/) - Visual development platform + +## Communities and Forums + +1. [Creative Applications Network](https://www.creativeapplications.net/) +2. [OpenProcessing](https://www.openprocessing.org/) +3. [Hackster.io](https://www.hackster.io/) +4. [Stack Overflow](https://stackoverflow.com/) + +## Blogs and Websites + +1. [Creative Coding](https://creativecoding.com/) +2. [The Creators Project](https://www.vice.com/en/topic/creators) +3. [Colossal](https://www.thisiscolossal.com/) +4. [Prosthetic Knowledge](https://prostheticknowledge.tumblr.com/) + +Remember to explore these resources and find the ones that best suit your learning style and interests!