Skip to content

Commit

Permalink
Adding initial documentation files
Browse files Browse the repository at this point in the history
  • Loading branch information
Bancie committed Aug 17, 2024
1 parent 4b7bf2c commit 66b6661
Show file tree
Hide file tree
Showing 5 changed files with 161 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
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: pip install mkdocs-encryptcontent-plugin # Install plugin from PyPI
- run: mkdocs gh-deploy --force
17 changes: 17 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Welcome to MkDocs

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

## 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.
Binary file added docs/tilearn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions encryptcontent.cache
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
kdf_iterations: 10000
obfuscate: {}
password: {}
userpass: {}
113 changes: 113 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
site_name: TiLearn
#site_url: https://s-roll.github.io/notebook.language/
site_author: Bang Nguyen
nav:
- Home: index.md

plugins:
- search: {}
- encryptcontent:
title_prefix: ''
summary: 'Bạn cần có password để vào được trang này.'
placeholder: 'Nhập password'
decryption_failure_message: 'Try again!'
encryption_info_message: "Vui lòng nhập password vào bên dưới"
input_class: 'md-search__form md-search__input'
button_class: 'md-search__icon'


theme:
name: material
features:
- toc.follow
- navigation.footer
- navigation.tabs
- navigation.tabs.sticky
- navigation.expand
- navigation.path
- navigation.indexes
- navigation.instant.preview
- navigation.sections
- navigation.top
- search.suggest
- search.highlight
- content.tabs.link
- content.code.annotation
- content.code.copy
language: en
palette:
- scheme: default
toggle:
icon: material/weather-sunny
name: Switch to dark mode
primary: yellow
accent: yellow
- scheme: slate
toggle:
icon: material/weather-night
name: Switch to light mode
primary: yellow
accent: yellow
font:
text: Open Sans
logo: tilearn.png
favicon: tilearn.png
icon:
logo: logo
admonition:
note: fontawesome/solid/note-sticky
abstract: fontawesome/solid/book
info: fontawesome/solid/circle-info
tip: fontawesome/solid/bullhorn
success: fontawesome/solid/check
question: fontawesome/solid/circle-question
warning: fontawesome/solid/triangle-exclamation
failure: fontawesome/solid/bomb
danger: fontawesome/solid/skull
bug: fontawesome/solid/robot
example: fontawesome/solid/flask
quote: fontawesome/solid/quote-left

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.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg


extra_javascript:
- javascripts/katex.js
- https://unpkg.com/katex@0/dist/katex.min.js
- https://unpkg.com/katex@0/dist/contrib/auto-render.min.js
- javascripts/mathjax.js
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

extra_css:
- https://unpkg.com/katex@0/dist/katex.min.css
- stylesheets/extra.css

copyright: |
&copy; 2024 <a href="https://web.facebook.com/ngchibangg" target="_blank" rel="noopener">Bang Nguyen</a>
extra:
#homepage: https://s-roll.github.io/notebook.language/
social:
- icon: fontawesome/brands/facebook
link: https://web.facebook.com/ngchibangg
- icon: fontawesome/brands/instagram
link: https://www.instagram.com/bancie.007/
- icon: fontawesome/brands/github
link: https://github.com/Bancie

0 comments on commit 66b6661

Please sign in to comment.