Giter Club home page Giter Club logo

hugo-theme-pico's Introduction

โšซ Pico

Netlify Status

This theme aims to be minimalist, readable, responsive, light and beautiful. Inspired by Medium and The New York Times, Pico try to provide the best experience for the reader while having an awesome design. It can be configured as a single page, or as a full-featured site with multiple sections. It is multilingual, responsive, and includes a light and dark theme.

You can check the example site. pico example screenshot

Features :

  • Multilingual - supports side-by-side content in different language versions
  • Syntax highlighting ("one dark" theme)
  • Styled Markdown throughout, including post titles
  • Customizable pages with widget or TailwindCSS
  • Straightforward customization via config.toml
  • Projects and Blog sections
  • Light, CSS bundle is purged and minified thanks to PostCSS
  • Light & Dark theme

Developer-friendly :

  • Sass files included with instant compiling to CSS thanks to Hugo Pipes and PostCSS
  • TailwindCSS for rapidly building custom design

Preview the theme

Pico ships with an fully configured example site. For a quick preview:

cd themes/pico/exampleSite/
hugo server --themesDir ../..

Then visit http://localhost:1313/ in your browser to view the example site.

Getting started

Requirements

Learn how to install and use npm here.

Get the theme

# Clone the repository
git clone https://github.com/negrel/hugo-theme-pico.git pico

# Copy the example site
mkdir my_website
cp -r pico/exampleSite/* my_website

# You can delete the cloned repository
rm -rf pico

# Navigate to your website
cd my_website

# Install the node modules and the theme via the script
./setup.sh

# OR manually
# Installing node modules
npm install

# Adding the theme as a submodule (better maintenance than a clone)
# NOTE: my_website/ must be a git repository
git submodule add -f https://github.com/negrel/hugo-theme-pico.git ./themes/pico

# Start the dev server
hugo server

Your website is running ๐Ÿ˜„, you can start editing content files.

Multilingual

Pico currently ships with support for 4 languages (fr, en, it, es). Contributions for other language translations are welcome. To create a new language translation, add the .toml file to the i18n/ folder. See the existing files for the necessary fields. See the hugo documentation for more details.

Menu

Pico contains a default menu. If you want to override this, you can do so by editing the menu.main in config.toml.

Google Analytics

Set googleAnalytics in config.toml to activate Hugo's internal Google Analytics template.

Contributing

If you want to contribute to Pico to add a feature or improve the code contact me at [email protected], open an issue or make a pull request.

๐ŸŒ  Show your support

Please give a โญ if this project helped you!

๐Ÿ“œ License

MIT ยฉ Alexandre Negrel

FOSSA Status

hugo-theme-pico's People

Contributors

dependabot[bot] avatar fossabot avatar mijorus avatar negrel avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.