You've already forked hugo-mod-twemoji
mirror of
https://github.com/jakejarvis/hugo-mod-twemoji.git
synced 2025-06-27 14:25:41 -04:00
initial commit 🎉
This commit is contained in:
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
resources/
|
||||||
|
_vendor/
|
21
LICENSE.md
Normal file
21
LICENSE.md
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2020-present Jake Jarvis <jake@jarv.is>
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
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.
|
23
README.md
Normal file
23
README.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
# hugo-mod-twemoji 📦
|
||||||
|
|
||||||
|
[**Twemoji**](https://twemoji.twitter.com/) (Twitter Emoji) is an open source library of over 3,000 Unicode emojis in both PNG and SVG formats. It also provides a script to swap out system-native emojis for these graphics to achieve a uniform appearance across all browsers and platforms.
|
||||||
|
|
||||||
|
This [Hugo Module](https://gohugo.io/hugo-modules/) can be used to import the Twemoji graphics and scripts locally into your Hugo project, rather than making external calls to Twitter's CDN.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Add the module to your Hugo project's `config.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[module]
|
||||||
|
[[module.imports]]
|
||||||
|
path = "github.com/jakejarvis/hugo-mod-twemoji"
|
||||||
|
```
|
||||||
|
|
||||||
|
The graphics will be mounted in `static/twemoji/png` and `static/twemoji/svg`, and the scripts in `static/twemoji/js`.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Twemoji graphics are licensed under [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) (CC-BY-4.0) by Twitter, Inc. and other contributors. Code is licensed under the [MIT License](http://opensource.org/licenses/MIT).
|
||||||
|
|
||||||
|
Refer to the main [Twemoji repository](https://github.com/twitter/twemoji) or [website](https://twemoji.twitter.com/) for more information.
|
15
config.toml
Normal file
15
config.toml
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
[module]
|
||||||
|
[[module.mounts]]
|
||||||
|
source = "static"
|
||||||
|
target = "static"
|
||||||
|
[[module.imports]]
|
||||||
|
path = "github.com/twitter/twemoji"
|
||||||
|
[[module.imports.mounts]]
|
||||||
|
source = "assets/72x72"
|
||||||
|
target = "static/twemoji/png"
|
||||||
|
[[module.imports.mounts]]
|
||||||
|
source = "assets/svg"
|
||||||
|
target = "static/twemoji/svg"
|
||||||
|
[[module.imports.mounts]]
|
||||||
|
source = "scripts"
|
||||||
|
target = "static/twemoji/js"
|
5
go.mod
Normal file
5
go.mod
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
module github.com/jakejarvis/hugo-mod-twemoji
|
||||||
|
|
||||||
|
go 1.13
|
||||||
|
|
||||||
|
require github.com/twitter/twemoji v12.1.5+incompatible // indirect
|
Reference in New Issue
Block a user