Skip to content

Commit

Permalink
Initial Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jdebnath21 committed Jan 4, 2024
1 parent 4a0b7e1 commit bd2dda9
Show file tree
Hide file tree
Showing 4 changed files with 154 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: ci
on:
push:
branches:
- master
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: 3.x
- uses: actions/cache@v2
with:
key: ${{ github.ref }}
path: .cache
- run: pip install mkdocs-material
# - run: pip install pillow cairosvg
- run: mkdocs gh-deploy --force
70 changes: 70 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Homepage

For full documentation visit [mkdocs.org](https://www.mkdocs.org).


## Code Annotation Examples

### Code Blocks

Some `code` goes here

### Plain Code Block

```
Random Code
def basefunction()
// Comments
```

### Code in specific language

Some Python Code with `py`

``` py
import tensorflow as tf
def whatever()
```

#### With some title

``` py title="bubblesort.py", linenums="1"
def bubble_sort(items):
for i in range(len(items)):
for j in range(len(items) - 1 -i):
if items[j] == items[j + 1]:
items[j], items[j + 1] = items[j + 1], items[j]

```

#### Highlight specific lines

``` py title="bubblesort.py", linenums="1", hl_lines="2 3"
def bubble_sort(items):
for i in range(len(items)):
for j in range(len(items) - 1 -i):
if items[j] == items[j + 1]:
items[j], items[j + 1] = items[j + 1], items[j]

```

<!-- ## Icons and Emojis
:smile: <br>
:fontawesome-regular-face-laugh-wink: -->



<!-- ## Commands
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.
## Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files. -->
5 changes: 5 additions & 0 deletions docs/page2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Page 2

## Another Heading

Some example text
56 changes: 56 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
site_name: Cloud Native Technology Innovations
theme:
name: material
features:
- navigation.tabs
- navigation.sections
- toc.integrate
- navigation.top
- search.suggest
- search.highlight
- content.tabs.link
- content.code.annotation
- content.code.copy
language: en
palette:
- scheme: default
toggle:
icon: material/toggle-switch-off-outline
name: Switch to Dark Mode
primary: teal
accent: purple
- scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to Light Mode
primary: teal
accent: lime

extra:
social:
- icon: fontawesome/brands/github-alt
link: https://github.com/jdebnath21
- icon: fontawesome/brands/twitter
link: https://twitter.com/jay_debnath
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/in/jayanta-debnath/

markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- admonition
- pymdownx.arithmatex:
generic: true
- footnotes
- pymdownx.details
- pymdownx.superfences
- pymdownx.mark
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg

copyright: |
&copy; 2023 <a href="https://github.com/jdebnath21" target="_blank" rel="noopener">Jayanta Debnath</a>

0 comments on commit bd2dda9

Please sign in to comment.