Skip to content

Commit 023b178

Browse files
committed
Initial GitHub Pages Push
1 parent 09fdba3 commit 023b178

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+6964
-2
lines changed

.gitattributes

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Auto detect text files and perform LF normalization
2+
* text=auto
3+
4+
# Custom for Visual Studio
5+
*.cs diff=csharp
6+
*.sln merge=union
7+
*.csproj merge=union
8+
*.vbproj merge=union
9+
*.fsproj merge=union
10+
*.dbproj merge=union
11+
12+
# Standard to msysgit
13+
*.doc diff=astextplain
14+
*.DOC diff=astextplain
15+
*.docx diff=astextplain
16+
*.DOCX diff=astextplain
17+
*.dot diff=astextplain
18+
*.DOT diff=astextplain
19+
*.pdf diff=astextplain
20+
*.PDF diff=astextplain
21+
*.rtf diff=astextplain
22+
*.RTF diff=astextplain

.github/workflows/mkdocs.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Run mkdocs
2+
on:
3+
push:
4+
branches:
5+
- main
6+
permissions:
7+
contents: write
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout repository
13+
uses: actions/checkout@v3
14+
15+
- name: Set up Python runtime
16+
uses: actions/setup-python@v4
17+
with:
18+
python-version: 3.x
19+
20+
- name: Install Python dependencies
21+
run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-with-pdf weasyprint mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2
22+
23+
- name: Set up build cache
24+
uses: actions/cache@v2
25+
with:
26+
key: ${{ github.ref }}
27+
path: .cache
28+
29+
- name: Install Insiders build
30+
env:
31+
GH_TOKEN: ${{ secrets.GH_TOKEN }}
32+
run: pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
33+
- run: mkdocs gh-deploy --force

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
### How to Contribute
2+
3+
Thank you so *much* for offering to help out. We truly appreciate it.
4+
5+
If you'd like to contribute, start by searching through the [issues](../../issues) and [pull requests](../../pulls) to see whether someone else has raised a similar idea or question.
6+
7+
If you are adding a feature to this library, please create a PR and follow these best practices:
8+
9+
* If you've added a new feature document it with a simple example sketch. This serves both as a test of your PR and as a quick way for users to quickly learn how to use your new feature.
10+
* If you add new functions also add them to keywords.txt so that they are properly highlighted in Arduino. [Read more](https://www.arduino.cc/en/Hacking/libraryTutorial).
11+
* PRs should change as little as possible. Do not submit a PR that changes 100 lines of whitespace. Break up into multiple PRs if necessary.
12+
13+
## Style guide
14+
15+
Please read and follow the [Arduino API style guide](https://www.arduino.cc/en/Reference/APIStyleGuide). Also read and consider the [Arduino style guide](https://www.arduino.cc/en/Reference/StyleGuide).

ISSUE_TEMPLATE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
### Subject of the issue
2+
Describe your issue here.
3+
4+
### Your workbench
5+
* What development board or microcontroller are you using?
6+
* What version of hardware or breakout board are you using?
7+
* How is the breakout board wired to your microcontroller?
8+
* How is everything being powered?
9+
* Are there any additional details that may help us help you?
10+
11+
### Steps to reproduce
12+
Tell us how to reproduce this issue. Please post stripped down example code demonstrating your issue.
13+
14+
### Expected behavior
15+
Tell us what should happen
16+
17+
### Actual behavior
18+
Tell us what happens instead

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
SparkFun Soft Power Switch Mk2 USB-C
22
===================================================
33

4-
[![SparkX Soft Power Switch Mk2 (PRT-28280)](./Hardware/Dimensions.png)](https://www.sparkfun.com/products/28280)
4+
[![SparkFun Soft Power Switch Mk2 (PRT-27081)](./Hardware/Dimensions.png)](https://www.sparkfun.com/products/27081)
55

6-
[*SparkX Soft Power Switch Mk2 (PRT-28280)*](https://www.sparkfun.com/products/28280)
6+
[*SparkFun Soft Power Switch Mk2 (PRT-27081)*](https://www.sparkfun.com/products/27081)
77

88

99
The Soft Power Switch Mk2 is a passive, hard on/off switch with software feedback and control. In other words, it's like the on/off switch on a laptop. A simple press will turn the system on. Another press can (with MCU intervention) turn off the system. And if things go really wrong, pressing and holding the button for ~7 seconds will force a power-down. If you're building something with an enclosed Thing Plus board and need a good power button, this is the board you need.
@@ -68,6 +68,7 @@ Repository Contents
6868

6969
Product Versions
7070
----------------
71+
* [PRT-27081](https://www.sparkfun.com/products/27081) - SparkFun REDs release.
7172
* [SPX-25366](https://www.sparkfun.com/products/25366) - Original SparkX Release.
7273

7374
License Information

0 commit comments

Comments
 (0)