├── .github ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── ISSUE_TEMPLATE.md ├── ISSUE_TEMPLATE │ ├── bug_report.md │ ├── feature_request.md │ └── question.md ├── PULL_REQUEST_TEMPLATE.md └── stale.yml ├── .gitignore ├── .travis.yml ├── CERTIFICATE ├── CHANGELOG.md ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── examples └── main.rs ├── src └── lib.rs └── tests ├── fixtures └── html-css.html └── test.rs /.github/CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of 9 | experience, 10 | education, socio-economic status, nationality, personal appearance, race, 11 | religion, or sexual identity and orientation. 12 | 13 | ## Our Standards 14 | 15 | Examples of behavior that contributes to creating a positive environment 16 | include: 17 | 18 | - Using welcoming and inclusive language 19 | - Being respectful of differing viewpoints and experiences 20 | - Gracefully accepting constructive criticism 21 | - Focusing on what is best for the community 22 | - Showing empathy towards other community members 23 | 24 | Examples of unacceptable behavior by participants include: 25 | 26 | - The use of sexualized language or imagery and unwelcome sexual attention or 27 | advances 28 | - Trolling, insulting/derogatory comments, and personal or political attacks 29 | - Public or private harassment 30 | - Publishing others' private information, such as a physical or electronic 31 | address, without explicit permission 32 | - Other conduct which could reasonably be considered inappropriate in a 33 | professional setting 34 | 35 | 36 | ## Our Responsibilities 37 | 38 | Project maintainers are responsible for clarifying the standards of acceptable 39 | behavior and are expected to take appropriate and fair corrective action in 40 | response to any instances of unacceptable behavior. 41 | 42 | Project maintainers have the right and responsibility to remove, edit, or 43 | reject comments, commits, code, wiki edits, issues, and other contributions 44 | that are not aligned to this Code of Conduct, or to ban temporarily or 45 | permanently any contributor for other behaviors that they deem inappropriate, 46 | threatening, offensive, or harmful. 47 | 48 | ## Scope 49 | 50 | This Code of Conduct applies both within project spaces and in public spaces 51 | when an individual is representing the project or its community. Examples of 52 | representing a project or community include using an official project e-mail 53 | address, posting via an official social media account, or acting as an appointed 54 | representative at an online or offline event. Representation of a project may be 55 | further defined and clarified by project maintainers. 56 | 57 | ## Enforcement 58 | 59 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 60 | reported by contacting the project team at yoshuawuyts@gmail.com, or through 61 | IRC. All complaints will be reviewed and investigated and will result in a 62 | response that is deemed necessary and appropriate to the circumstances. The 63 | project team is obligated to maintain confidentiality with regard to the 64 | reporter of an incident. 65 | Further details of specific enforcement policies may be posted separately. 66 | 67 | Project maintainers who do not follow or enforce the Code of Conduct in good 68 | faith may face temporary or permanent repercussions as determined by other 69 | members of the project's leadership. 70 | 71 | ## Attribution 72 | 73 | This Code of Conduct is adapted from the Contributor Covenant, version 1.4, 74 | available at 75 | https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 76 | -------------------------------------------------------------------------------- /.github/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | Contributions include code, documentation, answering user questions, running the 3 | project's infrastructure, and advocating for all types of users. 4 | 5 | The project welcomes all contributions from anyone willing to work in good faith 6 | with other contributors and the community. No contribution is too small and all 7 | contributions are valued. 8 | 9 | This guide explains the process for contributing to the project's GitHub 10 | Repository. 11 | 12 | - [Code of Conduct](#code-of-conduct) 13 | - [Bad Actors](#bad-actors) 14 | - [Developer Certificate of Origin](#developer-certificate-of-origin) 15 | 16 | ## Code of Conduct 17 | The project has a [Code of Conduct](./CODE_OF_CONDUCT.md) that *all* 18 | contributors are expected to follow. This code describes the *minimum* behavior 19 | expectations for all contributors. 20 | 21 | As a contributor, how you choose to act and interact towards your 22 | fellow contributors, as well as to the community, will reflect back not only 23 | on yourself but on the project as a whole. The Code of Conduct is designed and 24 | intended, above all else, to help establish a culture within the project that 25 | allows anyone and everyone who wants to contribute to feel safe doing so. 26 | 27 | Should any individual act in any way that is considered in violation of the 28 | [Code of Conduct](./CODE_OF_CONDUCT.md), corrective actions will be taken. It is 29 | possible, however, for any individual to *act* in such a manner that is not in 30 | violation of the strict letter of the Code of Conduct guidelines while still 31 | going completely against the spirit of what that Code is intended to accomplish. 32 | 33 | Open, diverse, and inclusive communities live and die on the basis of trust. 34 | Contributors can disagree with one another so long as they trust that those 35 | disagreements are in good faith and everyone is working towards a common 36 | goal. 37 | 38 | ## Bad Actors 39 | All contributors to tacitly agree to abide by both the letter and 40 | spirit of the [Code of Conduct](./CODE_OF_CONDUCT.md). Failure, or 41 | unwillingness, to do so will result in contributions being respectfully 42 | declined. 43 | 44 | A *bad actor* is someone who repeatedly violates the *spirit* of the Code of 45 | Conduct through consistent failure to self-regulate the way in which they 46 | interact with other contributors in the project. In doing so, bad actors 47 | alienate other contributors, discourage collaboration, and generally reflect 48 | poorly on the project as a whole. 49 | 50 | Being a bad actor may be intentional or unintentional. Typically, unintentional 51 | bad behavior can be easily corrected by being quick to apologize and correct 52 | course *even if you are not entirely convinced you need to*. Giving other 53 | contributors the benefit of the doubt and having a sincere willingness to admit 54 | that you *might* be wrong is critical for any successful open collaboration. 55 | 56 | Don't be a bad actor. 57 | 58 | ## Developer Certificate of Origin 59 | All contributors must read and agree to the [Developer Certificate of 60 | Origin (DCO)](../CERTIFICATE). 61 | 62 | The DCO allows us to accept contributions from people to the project, similarly 63 | to how a license allows us to distribute our code. 64 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## Summary 2 | Explain what is going on. 3 | 4 | ## Your Environment 5 | | Software | Version(s) | 6 | | ---------------- | ---------- | 7 | | html-index | 8 | | Rustc | 9 | | Operating System | 10 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug Report 3 | about: Did something not work as expected? 4 | --- 5 | 6 | # Bug Report 7 | ## Your Environment 8 | | Software | Version(s) | 9 | | ---------------- | ---------- | 10 | | html-index | 11 | | Rustc | 12 | | Operating System | 13 | 14 | ## Expected Behavior 15 | Tell us what should have happened. 16 | 17 | ## Current Behavior 18 | Tell us what happens instead of the expected behavior. If you are seeing an 19 | error, please include the full error message and stack trace. 20 | 21 | ## Code Sample 22 | Please provide a code repository, gist, code snippet or sample files to 23 | reproduce the issue. 24 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature Request 3 | about: Want us to add something to html-index? 4 | --- 5 | 6 | # Feature Request 7 | ## Summary 8 | One paragraph explanation of the feature. 9 | 10 | ## Motivation 11 | Why are we doing this? What use cases does it support? What is the expected 12 | outcome? 13 | 14 | ## Guide-level explanation 15 | Explain the proposal as if it was already included in the project and you 16 | were teaching it to another programmer. That generally means: 17 | 18 | - Introducing new named concepts. 19 | - Explaining the feature largely in terms of examples. 20 | - If applicable, provide sample error messages, deprecation warnings, or 21 | migration guidance. 22 | 23 | ## Reference-level explanation 24 | This is the technical portion of the feature request. Explain the design in 25 | sufficient detail that: 26 | 27 | - Its interaction with other features is clear. 28 | - It is reasonably clear how the feature would be implemented. 29 | - Corner cases are dissected by example. 30 | 31 | ## Drawbacks 32 | Why should we _not_ do this? 33 | 34 | ## Rationale and alternatives 35 | - Why is this design the best in the space of possible designs? 36 | - What other designs have been considered and what is the rationale for not 37 | choosing them? 38 | - What is the impact of not doing this? 39 | 40 | ## Unresolved Questions 41 | What related issues do you consider out of scope for this feature that could be 42 | addressed in the future independently of the solution that comes out of this 43 | feature? 44 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/question.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Question 3 | about: Have any questions regarding how html-index works? 4 | --- 5 | 6 | # Question 7 | ## Your Environment 8 | | Software | Version(s) | 9 | | ---------------- | ---------- | 10 | | html-index | 11 | | Rustc | 12 | | Operating System | 13 | 14 | ## Question 15 | Provide your question here. 16 | 17 | ## Context 18 | How has this issue affected you? What are you trying to accomplish? 19 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | 6 | 7 | **Choose one:** is this a 🐛 bug fix, a 🙋 feature, or a 🔦 documentation change? 8 | 9 | 10 | 11 | ## Checklist 12 | 13 | - [ ] tests pass 14 | - [ ] tests and/or benchmarks are included 15 | - [ ] documentation is changed or added 16 | 17 | ## Context 18 | 19 | 20 | ## Semver Changes 21 | 22 | -------------------------------------------------------------------------------- /.github/stale.yml: -------------------------------------------------------------------------------- 1 | # Configuration for probot-stale - https://github.com/probot/stale 2 | 3 | daysUntilStale: 90 4 | daysUntilClose: 7 5 | exemptLabels: 6 | - pinned 7 | - security 8 | exemptProjects: false 9 | exemptMilestones: false 10 | staleLabel: wontfix 11 | markComment: > 12 | This issue has been automatically marked as stale because it has not had 13 | recent activity. It will be closed if no further activity occurs. Thank you 14 | for your contributions. 15 | unmarkComment: false 16 | closeComment: false 17 | limitPerRun: 30 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | coverage/ 2 | target/ 3 | tmp/ 4 | dist/ 5 | npm-debug.log* 6 | Cargo.lock 7 | .DS_Store 8 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: rust 2 | rust: 3 | - nightly 4 | 5 | before_script: | 6 | rustup component add rustfmt-preview && 7 | cargo install clippy -f 8 | script: | 9 | cargo fmt -- --check && 10 | cargo clippy -- -D clippy && 11 | cargo build --verbose && 12 | cargo test --verbose 13 | cache: cargo 14 | -------------------------------------------------------------------------------- /CERTIFICATE: -------------------------------------------------------------------------------- 1 | Developer Certificate of Origin 2 | Version 1.1 3 | 4 | Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 5 | 1 Letterman Drive 6 | Suite D4700 7 | San Francisco, CA, 94129 8 | 9 | Everyone is permitted to copy and distribute verbatim copies of this 10 | license document, but changing it is not allowed. 11 | 12 | 13 | Developer's Certificate of Origin 1.1 14 | 15 | By making a contribution to this project, I certify that: 16 | 17 | (a) The contribution was created in whole or in part by me and I 18 | have the right to submit it under the open source license 19 | indicated in the file; or 20 | 21 | (b) The contribution is based upon previous work that, to the best 22 | of my knowledge, is covered under an appropriate open source 23 | license and I have the right under that license to submit that 24 | work with modifications, whether created in whole or in part 25 | by me, under the same open source license (unless I am 26 | permitted to submit under a different license), as indicated 27 | in the file; or 28 | 29 | (c) The contribution was provided directly to me by some other 30 | person who certified (a), (b) or (c) and I have not modified 31 | it. 32 | 33 | (d) I understand and agree that this project and the contribution 34 | are public and that a record of the contribution (including all 35 | personal information I submit with it, including my sign-off) is 36 | maintained indefinitely and may be redistributed consistent with 37 | this project or the open source license(s) involved. 38 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## 2018-11-17, Version 0.2.0 2 | ### Commits 3 | - [[`39c4f835a4`](https://github.com/rust-net-web/html-index/commit/39c4f835a4fc0f6656db232fe241d18b8bc2eca6)] (cargo-release) version 0.2.0 (Yoshua Wuyts) 4 | - [[`eb305217f8`](https://github.com/rust-net-web/html-index/commit/eb305217f88d54d0b6502b8ee2c959791e272277)] css auto-include preload shim (#2) (Yoshua Wuyts) 5 | - [[`8c11c4c604`](https://github.com/rust-net-web/html-index/commit/8c11c4c604a87a964a1f6a473545a900662bfa96)] Update changelog (Yoshua Wuyts) 6 | 7 | ### Stats 8 | ```diff 9 | CHANGELOG.md | 15 +++++++++++++++ 10 | Cargo.toml | 3 ++- 11 | src/lib.rs | 24 ++++++++++++++---------- 12 | 3 files changed, 31 insertions(+), 11 deletions(-) 13 | ``` 14 | 15 | 16 | ## 2018-10-13, Version 0.1.7 17 | ### Commits 18 | - [[`348ab7e5fb`](https://github.com/rust-net-web/html-index/commit/348ab7e5fb5ee81613913acf27c543d91aec3c76)] (cargo-release) version 0.1.7 (Yoshua Wuyts) 19 | - [[`4623004838`](https://github.com/rust-net-web/html-index/commit/46230048388101e39fbaae0f569a402f59737709)] fix desc (Yoshua Wuyts) 20 | - [[`34f817c70e`](https://github.com/rust-net-web/html-index/commit/34f817c70e9a9f569eb42ea4911479ff26d7538f)] Update changelog (Yoshua Wuyts) 21 | 22 | ### Stats 23 | ```diff 24 | CHANGELOG.md | 15 +++++++++++++++ 25 | Cargo.toml | 2 +- 26 | src/lib.rs | 3 +++ 27 | 3 files changed, 19 insertions(+), 1 deletion(-) 28 | ``` 29 | 30 | 31 | ## 2018-10-13, Version 0.1.6 32 | ### Commits 33 | - [[`2e8b9e088b`](https://github.com/rust-net-web/html-index/commit/2e8b9e088bd14bed1d585e5c213c4b11d3c4b875)] (cargo-release) version 0.1.6 (Yoshua Wuyts) 34 | - [[`0ce83d3f74`](https://github.com/rust-net-web/html-index/commit/0ce83d3f74f887294fcd7704249a1ad289d666e4)] fix title (Yoshua Wuyts) 35 | - [[`de00107123`](https://github.com/rust-net-web/html-index/commit/de00107123b85b35be93b1f202b7d5b975b89b18)] Update changelog (Yoshua Wuyts) 36 | 37 | ### Stats 38 | ```diff 39 | CHANGELOG.md | 17 +++++++++++++++++ 40 | Cargo.toml | 2 +- 41 | src/lib.rs | 3 +++ 42 | 3 files changed, 21 insertions(+), 1 deletion(-) 43 | ``` 44 | 45 | 46 | ## 2018-10-13, Version 0.1.5 47 | ### Commits 48 | - [[`f1402619ee`](https://github.com/rust-net-web/html-index/commit/f1402619ee78c87b3290d0d7ca818d3c2978cc4f)] (cargo-release) version 0.1.5 (Yoshua Wuyts) 49 | - [[`a1305ef198`](https://github.com/rust-net-web/html-index/commit/a1305ef198cb99828b4e2cce1840d3da42a642ab)] lang attr (Yoshua Wuyts) 50 | - [[`456da5a956`](https://github.com/rust-net-web/html-index/commit/456da5a9567ed209b1e3bf228867b55a2548cadd)] Update changelog (Yoshua Wuyts) 51 | 52 | ### Stats 53 | ```diff 54 | CHANGELOG.md | 15 +++++++++++++++ 55 | Cargo.toml | 2 +- 56 | src/lib.rs | 11 +++++++++-- 57 | tests/fixtures/html-css.html | 2 +- 58 | tests/test.rs | 2 +- 59 | 5 files changed, 27 insertions(+), 5 deletions(-) 60 | ``` 61 | 62 | 63 | ## 2018-10-13, Version 0.1.4 64 | ### Commits 65 | - [[`c8c30dbf28`](https://github.com/rust-net-web/html-index/commit/c8c30dbf28fa0de7becc0f07c701cdc9c9db03ff)] (cargo-release) version 0.1.4 (Yoshua Wuyts) 66 | - [[`1da7066537`](https://github.com/rust-net-web/html-index/commit/1da70665379516e17ce0799f6072c791b23a4325)] fix color (Yoshua Wuyts) 67 | - [[`3e83c483bb`](https://github.com/rust-net-web/html-index/commit/3e83c483bbfb1e184334ace1e7abd5d9a0f9a920)] Update changelog (Yoshua Wuyts) 68 | 69 | ### Stats 70 | ```diff 71 | CHANGELOG.md | 15 +++++++++++++++ 72 | Cargo.toml | 2 +- 73 | src/lib.rs | 4 ++++ 74 | 3 files changed, 20 insertions(+), 1 deletion(-) 75 | ``` 76 | 77 | 78 | ## 2018-10-12, Version 0.1.3 79 | ### Commits 80 | - [[`27f4697ad4`](https://github.com/rust-net-web/html-index/commit/27f4697ad4c72ecb5245ffcd065e2979794183de)] (cargo-release) version 0.1.3 (Yoshua Wuyts) 81 | - [[`0c84c9d9fd`](https://github.com/rust-net-web/html-index/commit/0c84c9d9fdcd03c01998e62075f335548919fb87)] inline script (Yoshua Wuyts) 82 | - [[`0ee0dbc67b`](https://github.com/rust-net-web/html-index/commit/0ee0dbc67b9bc5a8e01382ba556d708aa68180b4)] Update changelog (Yoshua Wuyts) 83 | 84 | ### Stats 85 | ```diff 86 | CHANGELOG.md | 16 ++++++++++++++++ 87 | Cargo.toml | 2 +- 88 | src/lib.rs | 9 +++++++++ 89 | 3 files changed, 26 insertions(+), 1 deletion(-) 90 | ``` 91 | 92 | 93 | ## 2018-10-12, Version 0.1.2 94 | ### Commits 95 | - [[`7607faab1c`](https://github.com/rust-net-web/html-index/commit/7607faab1c7753e4fbdae1d807c00cb5bd39f15e)] (cargo-release) version 0.1.2 (Yoshua Wuyts) 96 | - [[`aced86da8c`](https://github.com/rust-net-web/html-index/commit/aced86da8c4db3ea52134180e02999ae9aa762f6)] load scripts before styles (Yoshua Wuyts) 97 | - [[`f048748d72`](https://github.com/rust-net-web/html-index/commit/f048748d7229c1f105dce982ca43bb8e8415aca3)] document ff bug (Yoshua Wuyts) 98 | - [[`7a8e1bbca6`](https://github.com/rust-net-web/html-index/commit/7a8e1bbca6f24826fb33ced69dc016189662babd)] Update changelog (Yoshua Wuyts) 99 | 100 | ### Stats 101 | ```diff 102 | CHANGELOG.md | 37 +++++++++++++++++++++++++++++++++++++ 103 | Cargo.toml | 2 +- 104 | src/lib.rs | 8 +++++--- 105 | 3 files changed, 43 insertions(+), 4 deletions(-) 106 | ``` 107 | 108 | 109 | ## 2018-10-12, Version 0.1.1 110 | ### Commits 111 | - [[`39421b8828`](https://github.com/rust-net-web/html-index/commit/39421b8828266d68050cf7eb1ee2e905976fbee8)] (cargo-release) version 0.1.1 (Yoshua Wuyts) 112 | - [[`a3bee6f401`](https://github.com/rust-net-web/html-index/commit/a3bee6f401ac51ab4262ed4e3758780e75ce11d5)] fix css load on firefox (Yoshua Wuyts) 113 | - [[`56c3540c28`](https://github.com/rust-net-web/html-index/commit/56c3540c283a2edeffad88bd6d7bedeba80890ee)] test (Yoshua Wuyts) 114 | - [[`afb3c92837`](https://github.com/rust-net-web/html-index/commit/afb3c92837d8939f0c0f0afdb7affa2d8845e4bd)] include output (Yoshua Wuyts) 115 | - [[`87a999d7cb`](https://github.com/rust-net-web/html-index/commit/87a999d7cbff30a4c29b2db5e67db6b6304d27e3)] fix formatting on readme.md (Yoshua Wuyts) 116 | - [[`5c19ab9720`](https://github.com/rust-net-web/html-index/commit/5c19ab972094ed116f62f284fd325e045e3d9ef7)] first working version (Yoshua Wuyts) 117 | - [[`70380f7b5c`](https://github.com/rust-net-web/html-index/commit/70380f7b5c5c5477f8fb6f42c521222ada3d29bd)] init (Yoshua Wuyts) 118 | - [[`90ca0292fb`](https://github.com/rust-net-web/html-index/commit/90ca0292fb7c934d68b44ab8a7c6d0061cd40889)] . (Yoshua Wuyts) 119 | 120 | ### Stats 121 | ```diff 122 | .github/CODE_OF_CONDUCT.md | 75 ++++++++++++- 123 | .github/CONTRIBUTING.md | 63 ++++++++++- 124 | .github/ISSUE_TEMPLATE.md | 9 +- 125 | .github/ISSUE_TEMPLATE/bug_report.md | 23 ++++- 126 | .github/ISSUE_TEMPLATE/feature_request.md | 43 +++++++- 127 | .github/ISSUE_TEMPLATE/question.md | 18 +++- 128 | .github/PULL_REQUEST_TEMPLATE.md | 21 +++- 129 | .github/stale.yml | 17 +++- 130 | .gitignore | 7 +- 131 | .travis.yml | 13 ++- 132 | CERTIFICATE | 37 ++++++- 133 | Cargo.toml | 14 ++- 134 | LICENSE-APACHE | 190 +++++++++++++++++++++++++++++++- 135 | LICENSE-MIT | 21 +++- 136 | README.md | 83 ++++++++++++++- 137 | examples/main.rs | 10 ++- 138 | rustfmt.toml | 2 +- 139 | src/lib.rs | 189 +++++++++++++++++++++++++++++++- 140 | tests/fixtures/html-css.html | 1 +- 141 | tests/test.rs | 17 +++- 142 | 20 files changed, 853 insertions(+) 143 | ``` 144 | 145 | 146 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "html-index" 3 | version = "0.3.4" 4 | license = "MIT OR Apache-2.0" 5 | repository = "https://github.com/rust-net-web/html-index" 6 | documentation = "https://docs.rs/html-index" 7 | description = "Generate an HTML index." 8 | authors = ["Yoshua Wuyts "] 9 | readme = "README.md" 10 | edition = "2018" 11 | 12 | [dependencies] 13 | css-rel-preload = "0.1.0" 14 | http-types = { version = "2.1.0", optional = true } 15 | 16 | [dev-dependencies] 17 | anyhow = "1.0.32" 18 | 19 | [features] 20 | default = ["http-types"] 21 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | Copyright 2018 Yoshua Wuyts 179 | 180 | Licensed under the Apache License, Version 2.0 (the "License"); 181 | you may not use this file except in compliance with the License. 182 | You may obtain a copy of the License at 183 | 184 | http://www.apache.org/licenses/LICENSE-2.0 185 | 186 | Unless required by applicable law or agreed to in writing, software 187 | distributed under the License is distributed on an "AS IS" BASIS, 188 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 189 | See the License for the specific language governing permissions and 190 | limitations under the License. 191 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2018 Yoshua Wuyts 4 | 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: 11 | 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. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # html-index 2 | [![crates.io version][1]][2] [![build status][3]][4] 3 | [![downloads][5]][6] [![docs.rs docs][7]][8] 4 | 5 | Generate an HTML index. 6 | 7 | - [Documentation][8] 8 | - [Crates.io][2] 9 | - [Releases][releases] 10 | 11 | ## Why? 12 | Over the years the HTML spec has added lots of new capabilities in a backwards 13 | compatible fashion. This means that even if something from the 90's might still 14 | work in today's browsers, it might not always be the most efficient. 15 | 16 | This crate makes it easy to build performant HTML without needing to remember 17 | all boilerplate involved. 18 | 19 | ## Examples 20 | ### Basic 21 | ```rust 22 | extern crate html_index; 23 | 24 | pub fn main() { 25 | let res = html_index::Builder::new() 26 | .raw_body("hello world") 27 | .script("/bundle.js") 28 | .style("/bundle.css") 29 | .build(); 30 | println!("{}", res); 31 | } 32 | ``` 33 | 34 | Which generates: 35 | 36 | ```html 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | hello world 46 | 47 | ``` 48 | 49 | ## Installation 50 | ```sh 51 | $ cargo add html-index 52 | ``` 53 | 54 | ## Safety 55 | This crate uses ``#![deny(unsafe_code)]`` to ensure everything is implemented in 56 | 100% Safe Rust. 57 | 58 | ## Contributing 59 | Want to join us? Check out our ["Contributing" guide][contributing] and take a 60 | look at some of these issues: 61 | 62 | - [Issues labeled "good first issue"][good-first-issue] 63 | - [Issues labeled "help wanted"][help-wanted] 64 | 65 | ## References 66 | None. 67 | 68 | ## License 69 | [MIT](./LICENSE-MIT) OR [Apache-2.0](./LICENSE-APACHE) 70 | 71 | [1]: https://img.shields.io/crates/v/html-index.svg?style=flat-square 72 | [2]: https://crates.io/crates/html-index 73 | [3]: https://img.shields.io/travis/rust-net-web/html-index.svg?style=flat-square 74 | [4]: https://travis-ci.org/rust-net-web/html-index 75 | [5]: https://img.shields.io/crates/d/html-index.svg?style=flat-square 76 | [6]: https://crates.io/crates/html-index 77 | [7]: https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square 78 | [8]: https://docs.rs/html-index 79 | 80 | [releases]: https://github.com/rust-net-web/html-index/releases 81 | [contributing]: https://github.com/rust-net-web/html-index/.github/CONTRIBUTING.md 82 | [good-first-issue]: https://github.com/rust-net-web/html-index/labels/good%20first%20issue 83 | [help-wanted]: https://github.com/rust-net-web/html-index/labels/help%20wanted 84 | -------------------------------------------------------------------------------- /examples/main.rs: -------------------------------------------------------------------------------- 1 | extern crate html_index; 2 | 3 | pub fn main() { 4 | let res = html_index::Builder::new() 5 | .raw_body("hello world") 6 | .script("/bundle.js") 7 | .style("/bundle.css") 8 | .build(); 9 | println!("{}", res); 10 | } 11 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | #![cfg_attr(test, deny(warnings))] 2 | #![forbid(unsafe_code, missing_debug_implementations)] 3 | 4 | //! Over the years the HTML spec has added lots of new capabilities in a backwards 5 | //! compatible fashion. This means that even if something from the 90's might still 6 | //! work in today's browsers, it might not always be the most efficient. 7 | //! 8 | //! This crate makes it easy to build performant HTML without needing to remember 9 | //! all boilerplate involved. 10 | //! 11 | //! ## Features 12 | //! 13 | //! The `http-types` feature enables a `Builder::into()` conversion for [http_types::Response][]. 14 | //! This feature is enabled by default. 15 | //! 16 | //! If you are not using other http-types ecosystem crates, you can disable the feature: 17 | //! ```toml 18 | //! html-index = { version = "*", default-features = false } 19 | //! ``` 20 | //! 21 | //! [http_types::Response]: https://docs.rs/http-types/2.3.0/http_types/struct.Response.html 22 | //! 23 | //! ## Examples 24 | //! 25 | //! ```rust 26 | //! let res = html_index::Builder::new() 27 | //! .raw_body("hello world") 28 | //! .script("/bundle.js") 29 | //! .style("/bundle.css") 30 | //! .build(); 31 | //! println!("{}", res); 32 | //! ``` 33 | //! 34 | //! Which generates: 35 | //! 36 | //! ```html 37 | //! 38 | //! 39 | //! 40 | //! 41 | //! 42 | //! 43 | //! 44 | //! 45 | //! hello world 46 | //! 47 | //! ``` 48 | 49 | const DOCTYPE: &str = ""; 50 | const CHARSET: &str = r#""#; 51 | const VIEWPORT: &str = r#""#; 52 | const HTML_CLOSE: &str = ""; 53 | const HEAD_OPEN: &str = ""; 54 | const HEAD_CLOSE: &str = ""; 55 | 56 | use std::default::Default; 57 | 58 | /// Create a new `Builder` instance. 59 | pub fn new<'a>() -> Builder<'a> { 60 | Builder::new() 61 | } 62 | 63 | /// Create a new HTML builder. 64 | #[derive(Debug, Clone, Default)] 65 | pub struct Builder<'b> { 66 | color: Option, 67 | desc: Option, 68 | lang: &'b str, 69 | favicon: Option, 70 | fonts: Vec, 71 | manifest: Option, 72 | scripts: Vec, 73 | styles: Vec, 74 | title: Option, 75 | body: Option<&'b str>, 76 | has_async_style: bool, 77 | } 78 | 79 | impl<'b> Builder<'b> { 80 | /// Create a new instance from an HTML body, including `` tags. 81 | pub fn new() -> Self { 82 | Self { 83 | lang: "en-US", 84 | ..Default::default() 85 | } 86 | } 87 | 88 | /// Add a body to the document. The body must include `` tags. 89 | pub fn raw_body(mut self, body: &'b str) -> Self { 90 | self.body = Some(body); 91 | self 92 | } 93 | 94 | /// Set the document language. 95 | pub fn lang(mut self, lang: &'b str) -> Self { 96 | self.lang = lang; 97 | self 98 | } 99 | 100 | /// Add a `` tag. 101 | pub fn description(mut self, desc: &str) -> Self { 102 | let val = format!(r#""#, desc); 103 | self.desc = Some(val); 104 | self 105 | } 106 | 107 | /// Add a `` tag. 108 | pub fn theme_color(mut self, color: &str) -> Self { 109 | let val = format!(r#""#, color); 110 | self.color = Some(val); 111 | self 112 | } 113 | 114 | /// Add a `` tag. 115 | pub fn title(mut self, title: &str) -> Self { 116 | let val = format!(r#"<title>{}"#, title); 117 | self.title = Some(val); 118 | self 119 | } 120 | 121 | /// Add a `"#, src); 127 | self.scripts.push(val); 128 | self 129 | } 130 | 131 | /// Add a `"#, src); 135 | self.scripts.push(val); 136 | self 137 | } 138 | 139 | /// Add a `"#, src); 143 | self.scripts.push(val); 144 | self 145 | } 146 | 147 | /// Add a `` tag. This is ideal for loading scripts in 148 | /// the background after the main application has loaded. 149 | // TODO: also allow passing a sha512 150 | pub fn lazy_script(mut self, src: &str) -> Self { 151 | let val = format!(r#""#, src); 152 | self.scripts.push(val); 153 | self 154 | } 155 | 156 | /// Add a `"#, src); 161 | self.scripts.push(val); 162 | self 163 | } 164 | 165 | /// Add a `` tag. This is ideal for loading custom scripts 166 | /// that are essential for loading. 167 | // TODO: also allow passing a sha512 168 | pub fn inline_script(mut self, src: &str) -> Self { 169 | let val = format!(r#""#, src); 170 | self.scripts.push(val); 171 | self 172 | } 173 | 174 | /// Add a non-blocking `` tag. This is ideal for including 175 | /// styles that aren't essential for an initial render pass. 176 | /// 177 | /// Generally this should be combined with `.inline_style()` to optimize a 178 | /// render pipeline. 179 | /// 180 | /// `onerror` exists because of a bug in firefox. See https://github.com/filamentgroup/loadCSS/issues/246 for more details 181 | // TODO: also allow passing a sha512 182 | pub fn style(mut self, src: &str) -> Self { 183 | let val = format!( 184 | r#""#, 185 | src 186 | ); 187 | self.styles.push(val); 188 | 189 | if !self.has_async_style { 190 | self = self.inline_script(css_rel_preload::CSS_REL_PRELOAD); 191 | self.has_async_style = true; 192 | } 193 | 194 | self 195 | } 196 | 197 | /// Add an inline `"#, src); 205 | self.styles.push(val); 206 | self 207 | } 208 | 209 | /// Add a blocking `` tag. This is ideal for externally 210 | /// loading scripts that should be loaded before any rendering can be 211 | /// initialized. 212 | // TODO: also allow passing a sha512 213 | pub fn blocking_style(mut self, src: &str) -> Self { 214 | let val = format!(r#""#, src); 215 | self.styles.push(val); 216 | self 217 | } 218 | 219 | /// Add a favicon. 220 | pub fn favicon(mut self, src: &str) -> Self { 221 | let val = format!(r#""#, src); 222 | self.favicon = Some(val); 223 | self 224 | } 225 | 226 | /// Add a `manifest.json` link. 227 | pub fn manifest(mut self, src: &str) -> Self { 228 | let val = format!(r#""#, src); 229 | self.manifest = Some(val); 230 | self 231 | } 232 | 233 | /// Add a `` tag. 234 | pub fn font(mut self, src: &str) -> Self { 235 | let val = format!( 236 | r#""#, 237 | src 238 | ); 239 | self.fonts.push(val); 240 | self 241 | } 242 | 243 | /// Create an HTML document. 244 | pub fn build(self) -> String { 245 | let mut html: String = DOCTYPE.into(); 246 | html.push_str(&format!(r#""#, self.lang)); 247 | html.push_str(HEAD_OPEN); 248 | html.push_str(CHARSET); 249 | html.push_str(VIEWPORT); 250 | if let Some(title) = self.title { 251 | html.push_str(&title); 252 | } 253 | if let Some(desc) = self.desc { 254 | html.push_str(&desc); 255 | } 256 | 257 | for script in self.scripts { 258 | html.push_str(&script); 259 | } 260 | for style in self.styles { 261 | html.push_str(&style); 262 | } 263 | for font in self.fonts { 264 | html.push_str(&font); 265 | } 266 | if let Some(manifest) = self.manifest { 267 | html.push_str(&manifest); 268 | } 269 | 270 | if let Some(color) = self.color { 271 | html.push_str(&color); 272 | } 273 | if let Some(favicon) = self.favicon { 274 | html.push_str(&favicon); 275 | } 276 | html.push_str(HEAD_CLOSE); 277 | if let Some(body) = self.body { 278 | html.push_str(&body); 279 | } 280 | html.push_str(HTML_CLOSE); 281 | html 282 | } 283 | } 284 | 285 | #[cfg(feature = "http-types")] 286 | impl Into for Builder<'_> { 287 | fn into(self) -> http_types::Response { 288 | let mut res = http_types::Response::new(200); 289 | res.set_content_type(http_types::mime::HTML); 290 | res.set_body(self.build()); 291 | res 292 | } 293 | } 294 | -------------------------------------------------------------------------------- /tests/fixtures/html-css.html: -------------------------------------------------------------------------------- 1 | hello world 2 | -------------------------------------------------------------------------------- /tests/test.rs: -------------------------------------------------------------------------------- 1 | #[test] 2 | fn should_work() -> anyhow::Result<()> { 3 | let res = html_index::Builder::new() 4 | .raw_body("hello world") 5 | .script("/bundle.js") 6 | .style("/bundle.css") 7 | .build(); 8 | 9 | let expected = include_str!("./fixtures/html-css.html"); 10 | assert_eq!(res, expected.replace("\n", "")); 11 | Ok(()) 12 | } 13 | --------------------------------------------------------------------------------