File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ name : MkDocs CI
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+ - uses : actions/checkout@v4
13+ - name : Configure Git Credentials
14+ run : |
15+ git config user.name github-actions[bot]
16+ git config user.email 41898282+github-actions[bot]@users.noreply.github.com
17+ - uses : actions/setup-python@v5
18+ with :
19+ python-version : 3.x
20+ - run : echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
21+ - uses : actions/cache@v4
22+ with :
23+ key : mkdocs-material-${{ env.cache_id }}
24+ path : .cache
25+ restore-keys : |
26+ mkdocs-material-
27+ - run : pip install mkdocs-material
28+ - run : mkdocs gh-deploy --force
Original file line number Diff line number Diff line change 1+ # Welcome to MkDocs
2+
3+ For full documentation visit [ mkdocs.org] ( https://www.mkdocs.org ) .
4+
5+ ## Commands
6+
7+ * ` mkdocs new [dir-name] ` - Create a new project.
8+ * ` mkdocs serve ` - Start the live-reloading docs server.
9+ * ` mkdocs build ` - Build the documentation site.
10+ * ` mkdocs -h ` - Print help message and exit.
11+
12+ ## Project layout
13+
14+ mkdocs.yml # The configuration file.
15+ docs/
16+ index.md # The documentation homepage.
17+ ... # Other markdown pages, images and other files.
Original file line number Diff line number Diff line change 1+ site_url : https://rdma-rust.github.io
2+ repo_url : https://github.com/RDMA-Rust/rdma-rust.github.io
3+
4+ site_name : RDMA-Rust
5+
6+ theme :
7+ name : material
8+ custom_dir : overrides
9+ features :
10+ - navigation.tabs
11+ - navigation.tabs.sticky
12+ - navigation.top
13+ - search.suggest
14+ - search.highlight
15+ - toc.follow
16+
17+ plugins :
18+ - blog
19+ - search
20+ - git-committers :
21+ repository : RDMA-Rust/rdma-rust.github.io
22+ branch : main
23+
24+ nav :
25+ - Home : index.md
26+ - Blog :
27+ - blog/index.md
Original file line number Diff line number Diff line change 1+ {% if page.file.src_uri.startswith('blog/posts') %}
2+ < script src ="https://giscus.app/client.js "
3+ data-repo ="RDMA-Rust/rdma-rust.github.io "
4+ data-repo-id ="R_kgDON_6MMg "
5+ data-category ="Announcements "
6+ data-category-id ="DIC_kwDON_6MMs4CnZhW "
7+ data-mapping ="title "
8+ data-strict ="0 "
9+ data-reactions-enabled ="1 "
10+ data-emit-metadata ="1 "
11+ data-input-position ="top "
12+ data-theme ="preferred_color_scheme "
13+ data-lang ="en "
14+ crossorigin ="anonymous "
15+ async >
16+ </ script >
17+ {% endif %}
You can’t perform that action at this time.
0 commit comments