Skip to content

Commit 97302f8

Browse files
dumindudumindu
committed
🌱 Removing Hexo setup and adding initial Hugo setup
1 parent 822f803 commit 97302f8

File tree

94 files changed

+323
-1744
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+323
-1744
lines changed

‎.eslintignore

-3
This file was deleted.

‎.eslintrc

-4
This file was deleted.

‎.github/workflows/gh-pages.yml

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Clone repository
14+
uses: actions/checkout@v3
15+
16+
- name: Clone Docura theme repository
17+
uses: actions/checkout@v3
18+
with:
19+
repository: docura/docura
20+
path: themes/docura
21+
22+
- name: Setup Hugo
23+
uses: peaceiris/actions-hugo@v2
24+
with:
25+
hugo-version: 'latest'
26+
extended: true
27+
28+
- name: Build
29+
run: hugo --minify
30+
31+
- name: Deploy
32+
uses: peaceiris/actions-gh-pages@v3
33+
if: ${{ github.ref == 'refs/heads/main' }}
34+
with:
35+
deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
36+
external_repository: learning-rust/learning-rust.github.io
37+
publish_branch: main
38+
publish_dir: ./public

‎.gitignore

+5-9
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
.DS_Store
2-
.idea/
3-
node_modules/
4-
*.log
5-
db.json
6-
public/
7-
.deploy*/
8-
package-lock.json
9-
yarn.lock
1+
/.idea
102
/.vscode
3+
/public
4+
.DS_Store
5+
/resources/
6+
.hugo_build.lock

‎.gitmodules

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "themes/docura"]
2+
path = themes/docura
3+
url = https://github.com/docura/docura.git

‎.npmrc

-1
This file was deleted.

‎GitRepoUpdateTimestamp.sh

-82
This file was deleted.

‎LICENSE

+18-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,21 @@
1-
Copyright (c) 2015-2020 Dumindu Madunuwan
1+
MIT License
22

3-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
3+
Copyright (c) 2015-2022 Dumindu Madunuwan
44

5-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
611

7-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+46-60
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,63 @@
11
# Learning Rust
22

3+
This website is built using [Hugo](https://gohugo.io/) and [Docura](https://docura.github.io/).
4+
5+
## Local setup
6+
- [Install the extended version of Hugo](https://gohugo.io/getting-started/installing/)
7+
- Clone the repository and start Hugo server
8+
```
9+
$ git clone --depth 1 https://github.com/learning-rust/site.git
10+
$ cd site
11+
$ git submodule update --init --recursive
12+
$ hugo server
13+
```
14+
15+
## Content
16+
317
### Basics
4-
* [Why Rust](source/docs/a1.why_rust.md)
5-
* [Installation](source/docs/a2.installation.md)
6-
* [Hello World](source/docs/a3.hello_world.md)
7-
* [Cargo,crates and basic project structure](source/docs/a4.cargo,crates_and_basic_project_structure.md)
8-
* [Comments and documenting the code](source/docs/a5.comments_and_documenting_the_code.md)
9-
* [Variable bindings, constants and statics](source/docs/a6.variable_bindings,constants_and_statics.md)
10-
* [Functions](source/docs/a7.functions.md)
11-
* [Primitive data types](source/docs/a8.primitive_data_types.md)
12-
* [Operators](source/docs/a9.operators.md)
13-
* [Control flows](source/docs/a10.control_flows.md)
18+
* [Why Rust](content/en/docs/a1.why-rust.md)
19+
* [Installation](content/en/docs/a2.installation.md)
20+
* [Hello World](content/en/docs/a3.hello-world.md)
21+
* [Cargo,crates and basic project structure](content/en/docs/a4.cargo-crates-and-basic-project-structure.md)
22+
* [Comments and documenting the code](content/en/docs/a5.comments-and-documenting-the-code.md)
23+
* [Variable bindings, constants and statics](content/en/docs/a6.variable-bindings-constants-and-statics.md)
24+
* [Functions](content/en/docs/a7.functions.md)
25+
* [Primitive data types](content/en/docs/a8.primitive-data-types.md)
26+
* [Operators](content/en/docs/a9.operators.md)
27+
* [Control flows](content/en/docs/a10.control-flows.md)
1428
1529
### Beyond The Basics
16-
* [Vectors](source/docs/b1.vectors.md)
17-
* [Structs](source/docs/b2.structs.md)
18-
* [Enums](source/docs/b3.enums.md)
19-
* [Generics](source/docs/b4.generics.md)
20-
* [Impls and traits](source/docs/b5.impls_and_traits.md)
30+
* [Vectors](content/en/docs/b1.vectors.md)
31+
* [Structs](content/en/docs/b2.structs.md)
32+
* [Enums](content/en/docs/b3.enums.md)
33+
* [Generics](content/en/docs/b4.generics.md)
34+
* [Impls and traits](content/en/docs/b5.impls-and-traits.md)
2135
2236
### The Tough Part
23-
* [Ownership](source/docs/c1.ownership.md)
24-
* [Borrowing](source/docs/c2.borrowing.md)
25-
* [Lifetimes](source/docs/c3.lifetimes.md)
37+
* [Ownership](content/en/docs/c1.ownership.md)
38+
* [Borrowing](content/en/docs/c2.borrowing.md)
39+
* [Lifetimes](content/en/docs/c3.lifetimes.md)
2640
2741
### Lets Get It Started
28-
* [Code organization](source/docs/d1.code_organization.md)
29-
* [Functions](source/docs/d2.functions.md)
30-
* [Modules](source/docs/d3.modules.md)
31-
* [Crates](source/docs/d4.crates.md)
32-
* [Workspaces](source/docs/d5.workspaces.md)
33-
* [use](source/docs/d6.use.md)
34-
* [std, primitives and preludes](source/docs/d7.std_primitives_and_preludes.md)
42+
* [Code organization](content/en/docs/d1.code-organization.md)
43+
* [Functions](content/en/docs/d2.functions.md)
44+
* [Modules](content/en/docs/d3.modules.md)
45+
* [Crates](content/en/docs/d4.crates.md)
46+
* [Workspaces](content/en/docs/d5.workspaces.md)
47+
* [use](content/en/docs/d6.use.md)
48+
* [std, primitives and preludes](content/en/docs/d7.std-primitives-and-preludes.md)
3549
3650
### Error Handling
37-
* [Smart Compiler](source/docs/e1.smart_compiler.md)
38-
* [Panicking](source/docs/e2.panicking.md)
39-
* [Option and Result](source/docs/e3.option_and_result.md)
40-
* [Unwrap and Expect](source/docs/e4.unwrap_and_expect.md)
41-
* [Error and None Propagation](source/docs/e5.error_and_none_propagation.md)
42-
* [Combinators](source/docs/e6.combinators.md)
43-
* [Custom Error Types](source/docs/e7.custom_error_types.md)
51+
* [Smart Compiler](content/en/docs/e1.smart-compiler.md)
52+
* [Panicking](content/en/docs/e2.panicking.md)
53+
* [Option and Result](content/en/docs/e3.option-and-result.md)
54+
* [Unwrap and Expect](content/en/docs/e4.unwrap-and-expect.md)
55+
* [Error and None Propagation](content/en/docs/e5.error-and-none-propagation.md)
56+
* [Combinators](content/en/docs/e6.combinators.md)
57+
* [Custom Error Types](content/en/docs/e7.custom-error-types.md)
4458
4559
---
4660
* Site : http://learning-rust.github.io
4761
* Medium: https://medium.com/learning-rust
4862
4963
> 🐣 I am a **Sri Lankan**🇱🇰 Web Developer who lives in **Singapore**🇸🇬. I am not a native English speaker and just practicing Rust in my leisure time, while working as a Golang/Devops developer. So, if you found any mistake or something I need to be changed, even a spelling/ grammar mistake, feel free to buzz me.
50-
51-
---
52-
53-
# learning-rust.github.io(source)
54-
55-
The website is built with [Hexo](https://hexo.io/) Nodejs blog framework. You can see the generated files at [learning-rust/learning-rust.github.io](https://github.com/learning-rust/learning-rust.github.io) repository.
56-
57-
## Getting started
58-
59-
Install dependencies:
60-
61-
``` bash
62-
$ git clone https://github.com/learning-rust/site.git
63-
$ cd site
64-
$ npm install
65-
```
66-
67-
Generate:
68-
69-
``` bash
70-
$ hexo generate
71-
```
72-
73-
Run server:
74-
75-
``` bash
76-
$ hexo server
77-
```

‎_config.yml

-28
This file was deleted.

‎config/_default/config.toml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
title = 'Learning Rust'
2+
baseURL = 'https://learning-rust.github.io/'
3+
4+
defaultContentLanguage = 'en'
5+
languageCode = 'en-us'
6+
7+
googleAnalytics = 'G-FZHQCXSZ89'
8+
9+
enableGitInfo = true
10+
11+
theme = 'docura'
12+
13+
markup.highlight.noClasses = false

‎config/_default/languages.toml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[en]
2+
contentDir = 'content/en'
3+
languageName = 'English'
4+
weight = 1

‎config/_default/menu.toml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
[[main]]
2+
identifier = 'home'
3+
name = 'Home'
4+
pre = "<i class='icon icon-home'></i>"
5+
url = '/'
6+
weight = 1
7+
8+
[[main]]
9+
identifier = 'docs'
10+
name = 'Documentation'
11+
pre = "<i class='icon icon-book'></i>"
12+
url = '/docs/'
13+
weight = 2

‎config/_default/params.toml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
description = 'Rust Programming Language Tutorials'
2+
3+
author = 'Dumindu Madunuwan'
4+
authorURL = 'https://github.com/dumindu'
5+
6+
facebookURL = ''
7+
twitterURL = ''
8+
githubURL = 'https://github.com/learning-rust'
9+
youtubeURL = ''
10+
11+
githubRepo = 'learning-rust/site'
12+
githubSponsorURL = 'https://github.com/sponsors/dumindu'
13+
buyMeACoffeeURL = 'https://www.buymeacoffee.com/dumindu'
14+
15+
hugoURL = 'https://gohugo.io/'
16+
docuraURL = 'https://docura.github.io/'
17+
18+
[algolia]
19+
[algolia.en]
20+
container = '#site-header-search'
21+
appId = 'QEN78N5RTO'
22+
indexName = 'learning_rust'
23+
apiKey = '5c62287966941f0b43ee0b4d00e28238'

0 commit comments

Comments
 (0)