diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 000000000..67f46faa4 --- /dev/null +++ b/.github/workflows/ci.yml @@ -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 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..000ea3455 --- /dev/null +++ b/docs/index.md @@ -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. diff --git a/docs/tilearn.png b/docs/tilearn.png new file mode 100644 index 000000000..4fb48abf5 Binary files /dev/null and b/docs/tilearn.png differ diff --git a/encryptcontent.cache b/encryptcontent.cache new file mode 100644 index 000000000..f2f2d20c2 --- /dev/null +++ b/encryptcontent.cache @@ -0,0 +1,4 @@ +kdf_iterations: 10000 +obfuscate: {} +password: {} +userpass: {} diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 000000000..6f405ff59 --- /dev/null +++ b/mkdocs.yml @@ -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: | + © 2024 Bang Nguyen + +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 \ No newline at end of file