Font-gis NPM | npm.io

Font-GIS

Icon font set for use with GIS and spatial analysis tools

npm.io npm.io npm.io

I've collected in this repo icons and graphics I've been using in my projects. Font-GIS icons and font theme is designed mainly for GIS applications and web mapping tools. They can be easily included in a project using the font or svg images.

See demo page and examples

Getting started

NPM package

Font-GIS is availiable on npm:

npm install --save font-gis

You can access the font or css in the ./font and ./css directory of the package.
The svg sprites are located in the ./dist/font-gis.svg SVG file.

using Font-GIS

You can use Font-GIS as a font or as SVG symbols or images.

To use it in a web page, just add the css in your project.

<link href="https://viglino.github.io/font-gis/css/font-gis.css" rel="stylesheet" />

Then use an inline element with a class prefixed with fg- to add a new icon.

<!-- prefix: fg - icon name: poi -->
<i class="fg-poi"></i>
<!-- using a <span> is more semantically correct but a little bit verbose. -->
<span class="fg-polyline-pt"></span>

Or use it as an svg sprite (svg sprites are inlocated in the ./dist/font-gis.svg file):

<svg class="font-gis fg-3x"><use xlink:href="path/to/dist/font-gis.svg#fg-polyline-pt" /></svg>

Contributing

Please use the GitHub issue tracker to ask for new features or create a pull request.
Font is created from the files in the ./svg folder, you only have to create a new file in this folder. Use the ./templates/template.svg template to create a new icon.
You can add a new glyph in the font-gis.json file with a theme and search tags (other fields will be filled automatically).

Your contribution will be published under Font-GIS license as per GitHub's terms of service.

If you wan't to build the font and create the dist, use the build script (run npm install to install the dev dependencies before):

npm run build

Use a local server (http://localhost:8181/) to see result on the page:

npm start

Licenses

Font-GIS is licensed under Apache-2.0
Copyright (c) 2021 Jean-Marc Viglino

Font-GIS is free, open source, and GPL friendly. You can use it for commercial projects, open source projects, or really almost whatever you want. Read full Font-GIS license

Dual-license can be used for each specific part:

Font-GIS font is licensed under the SIL OFL 1.1 License
Icons and SVG files are licensed under the CC BY 4.0 License
Codes and all non font or icon files are licensed under the MIT License

Attribution is required by Apache, MIT, SIL OFL, and CC BY licenses. Font-GIS files already contain embedded comments with sufficient attribution, so you shouldn't need to do anything additional when using these files normally.