generated from just-the-docs/just-the-docs-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
75 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,16 @@ | ||
--- | ||
title: Home | ||
layout: home | ||
--- | ||
# tech-writing-portfolio | ||
Welcome to my technical writing portfolio! | ||
|
||
This is a *bare-minimum* template to create a Jekyll site that uses the [Just the Docs] theme. You can easily set the created site to be published on [GitHub Pages] – the [README] file explains how to do that, along with other details. | ||
Here are some projects I will include in my portfolio: | ||
* Sample 1: Process document | ||
|
||
If [Jekyll] is installed on your computer, you can also build and preview the created site *locally*. This lets you test changes before committing them, and avoids waiting for GitHub Pages.[^1] And you will be able to deploy your local build to a different platform than GitHub Pages. | ||
|
||
More specifically, the created site: | ||
https://github.com/delia-li/tech-writing-portfolio/assets/14004788/9d6d75d0-bb59-4eb2-b576-d232e4916db1 | ||
|
||
- 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 | ||
|
||
Other than that, you're free to customize sites that you create with this template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins. | ||
|
||
[Browse our documentation][Just the Docs] to learn more about how to use this theme. | ||
* [Sample 2: An overview of features in Insights Capture, a screen recording software](./insights_capture/insights_capture.md) | ||
|
||
To get started with creating a site, simply: | ||
* Sample 3: App design technical proof-of-concept | ||
|
||
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](https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md#hosting-your-docs-from-an-existing-project-repo) in the template README. | ||
|
||
---- | ||
|
||
[^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). | ||
|
||
[Just the Docs]: https://just-the-docs.github.io/just-the-docs/ | ||
[GitHub Pages]: https://docs.github.com/en/pages | ||
[README]: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md | ||
[Jekyll]: https://jekyllrb.com | ||
[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/ | ||
[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate | ||
* Sample 4: Open Source documentation work for OneBusAway |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# An overview of features in Insights Capture, a screen recording software | ||
|
||
Sometimes you want to show your friends a really neat trick that’s difficult to explain over text. Using Insights Capture, you can record your computer's screen with ease, make edits, and share your clips over social media such as discord and facebook. | ||
|
||
In this feature overview, you will learn how to use the free features in Insights Capture to record your screen, edit videos, add comments, and share videos on social media. Let’s get started! | ||
|
||
## What is Insights Capture? | ||
Insights Capture is primarily used by the PC gaming community to record games, watch replays, and get feedback from peers and coaches. Insights Capture runs automatically on certain games that use Overwolf, a software that gathers in-game data to enhance the player experience. However, we can also benefit from the features Insights Capture has to offer in many contexts outside of gaming. | ||
|
||
## Getting started with Insights Capture | ||
You can download the app for Windows desktop at [Insights.gg](insights.gg). | ||
It’s free, and you won’t need to create an account because you can use your email later. | ||
|
||
<img src="./hero_image.png" width="800"> | ||
|
||
|
||
Save the installer somewhere you’ll remember. Many users select `Downloads`. | ||
<img src="./downloads.png" width="800"> | ||
|
||
Run the installer, click `Yes` to allow it to make changes to your computer, and then follow the instructions. | ||
<img src="./installer.png" width="600"> | ||
|
||
Once the installation is complete, click launch. | ||
|
||
Sign in with your email and follow the last set of steps for setup. | ||
<img src="./signin.png" width="600"> | ||
|
||
Now you’re ready to go! You can start using the features below. | ||
<img src="./ready.png" width="600"> | ||
|
||
## Recording your screen | ||
The primary feature of Insights Capture is recording your screen. While most users use this app to record their gaming sessions, you can also use Insights to take any screen recording outside of gaming. | ||
|
||
### Method 1: Games supported by Overwolf | ||
If Overwolf supports your game, you can use Insights Capture to record your game automatically. If you just want to record your screen or you want to record a game that is not integrated with Overwolf, check out [Method 2](./insights_capture.md#method-2-all-other-screen-recordings). | ||
|
||
You can enable auto-recording in `Settings > Recording > Enable auto record`. When this is enabled, Insights Capture will automatically start recording when your Overwolf-supported game begins, and finish recording once your game has finished. | ||
<img src="./auto_record_setting.png" width="800"> | ||
|
||
You can also turn off auto-record in settings and start recording in the overlay that shows up at the start of each game. You can adjust the settings for each specific game at `Settings > [Your game] > Auto launch`. | ||
<img src="./game_specific_launch_setting.png" width="500"> | ||
|
||
You can start and stop recordings using the in-game overlay. | ||
![Image of overlay in an Overwolf-supported game](./overlay.png) | ||
|
||
### Method 2: All other screen recordings | ||
Click on the Screen Recorder button at the top left of Insights Capture. In the dropdown, click the red button to begin recording. Click it again to stop recording. | ||
![Image of the screen recording option in insights capture](./screen_recording.png) | ||
|
||
## Editing videos | ||
A nice feature of Insights Capture is that you can make simple edits to videos without having to download a separate video editing software. You can take short clips of a long video, or merge clips into a single video of highlights to share with your friends. | ||
|
||
### Clipping videos | ||
Click on the video you want to take a clip of. At the bottom left, click on `Clip`. You can also click on the Scissors icon in the top right corner. | ||
|
||
This will bring up a yellow slider that you can resize or drag to cover the length of the clip you want to make. | ||
|
||
Another way to clip is to type in the exact timestampe you want your clip to start and end, in the top right corner. | ||
|
||
### Merging videos | ||
|
||
|
||
## Leaving comments and notes on videos | ||
|
||
## Importing and exporting videos to your file system | ||
|
||
## Sharing videos on social media |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.