-
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added initial support for readthedocs
- Loading branch information
1 parent
18846e6
commit afa6ec2
Showing
10 changed files
with
150 additions
and
1 deletion.
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 |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# https://docs.readthedocs.io/en/stable/config-file/index.html | ||
|
||
# .readthedocs.yaml | ||
# Read the Docs configuration file | ||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
||
# Required | ||
version: 2 | ||
|
||
build: | ||
os: ubuntu-22.04 | ||
tools: | ||
python: "3.11" | ||
|
||
mkdocs: | ||
configuration: mkdocs.yml | ||
|
||
python: | ||
install: | ||
- requirements: docs/requirements.txt | ||
|
||
# # Build PDF & ePub | ||
formats: all | ||
# - epub | ||
File renamed without changes.
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
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
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,35 @@ | ||
# PoshGram | ||
|
||
[![Minimum Supported PowerShell Version](https://img.shields.io/badge/PowerShell-6.1+-blue.svg)](https://github.com/PowerShell/PowerShell) [![PowerShell Gallery][psgallery-img]][psgallery-site] ![Cross Platform](https://img.shields.io/badge/platform-windows%20%7C%20macos%20%7C%20linux-lightgrey) [![License][license-badge]](LICENSE) [![Documentation Status](https://readthedocs.org/projects/poshgram/badge/?version=latest)](https://poshgram.readthedocs.io/en/latest/?badge=latest) | ||
|
||
[psgallery-img]: https://img.shields.io/powershellgallery/dt/PoshGram.svg | ||
[psgallery-site]: https://www.powershellgallery.com/packages/PoshGram | ||
[psgallery-v1]: https://www.powershellgallery.com/packages/PoshGram | ||
[license-badge]: https://img.shields.io/github/license/techthoughts2/PoshGram | ||
|
||
## What is PoshGram? | ||
|
||
## Why PoshGram? | ||
|
||
## Getting Started | ||
|
||
### Prerequisites | ||
|
||
### Installation | ||
|
||
```powershell | ||
Install-Module -Name 'PoshGram' -Repository PSGallery -Scope CurrentUser | ||
``` | ||
|
||
### Quick Start | ||
|
||
```powershell | ||
#------------------------------------------------------------------------------------- | ||
# import the PoshGram module | ||
Import-Module -Name "PoshGram" | ||
#------------------------------------------------------------------------------------- | ||
``` | ||
|
||
## How PoshGram Works | ||
|
||
## Features |
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,7 @@ | ||
# https://github.com/readthedocs-examples/example-mkdocs-basic/blob/main/docs/requirements.txt | ||
# requirements.txt | ||
jinja2==3.0.3 | ||
mkdocs>=1.4.2 | ||
mkdocs-material>=9.0.12 #https://github.com/squidfunk/mkdocs-material | ||
pygments>=2.14.0 | ||
# mdx_truly_sane_lists |
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,82 @@ | ||
# https://www.mkdocs.org/user-guide/configuration/ | ||
# https://www.mkdocs.org/user-guide/writing-your-docs/ | ||
# https://www.mkdocs.org/user-guide/writing-your-docs/#writing-with-markdown | ||
# https://mkdocs.readthedocs.io/en/0.15.2/user-guide/writing-your-docs/ | ||
# https://mkdocs.readthedocs.io/en/0.15.2/user-guide/styling-your-docs/ | ||
# https://example-mkdocs-basic.readthedocs.io/en/latest/ | ||
# https://github.com/mkdocs/mkdocs/blob/master/mkdocs.yml | ||
# https://squidfunk.github.io/mkdocs-material/creating-your-site/ | ||
# mkdocs.yml | ||
|
||
site_name: PoshGram | ||
# site_url: | ||
repo_url: https://github.com/techthoughts2/PoshGram | ||
# repo_name: | ||
# edit_uri: edit/main/docs/ | ||
# edit_uri_template: | ||
site_description: PoshGram TBD. # meta tag to the generated HTML header | ||
site_author: Jake Morrison # meta tag to the generated HTML header | ||
copyright: "PoshGram is licensed under the <a href='https://github.com/techthoughts2/PoshGram/blob/main/LICENSE'>MIT license" | ||
# remote_branch: | ||
# remote_name: | ||
# docs_dir: docs | ||
# site_dir: | ||
# extra_css: | ||
# extra_javascript: | ||
markdown_extensions: | ||
# Python Markdown | ||
- admonition | ||
- toc: | ||
permalink: true | ||
# code highlighting | ||
- pymdownx.highlight: | ||
use_pygments: true | ||
- pymdownx.highlight: | ||
anchor_linenums: true | ||
- pymdownx.inlinehilite | ||
- pymdownx.snippets | ||
- pymdownx.superfences | ||
|
||
# extra_templates: | ||
# extra: | ||
theme: | ||
name: material | ||
language: en | ||
# custom_dir: overrides | ||
features: | ||
# - navigation.tabs | ||
# - navigation.tabs.sticky | ||
# - navigation.path | ||
# favicon: | ||
# icon: | ||
# repo: | ||
# font: | ||
# text: Work Sans | ||
# logo: | ||
# palette: | ||
# primary: teal | ||
# palette: | ||
# # Palette toggle for light mode | ||
# - media: "(prefers-color-scheme: light)" | ||
# scheme: default | ||
# primary: light blue | ||
# accent: pink | ||
# toggle: | ||
# icon: material/brightness-7 | ||
# name: Switch to dark mode | ||
|
||
# # Palette toggle for dark mode | ||
# - media: "(prefers-color-scheme: dark)" | ||
# scheme: slate | ||
# primary: indigo | ||
# accent: pink | ||
# toggle: | ||
# icon: material/brightness-4 | ||
# name: Switch to light mode | ||
nav: | ||
- Home: index.md | ||
- Usage: | ||
- Functions: | ||
- Getting An API Key: | ||
- FAQ: PoshGram-FAQ.md | ||
- Change Log: CHANGELOG.md |