From daba4dbdf29b118b675ce85e57c0d6fe397898be Mon Sep 17 00:00:00 2001 From: attuccigiulio <84907550+attuccigiulio@users.noreply.github.com> Date: Tue, 6 Jul 2021 17:37:00 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 50 +++----------------------------------------------- 1 file changed, 3 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 0f62222c46..cdd6cfc581 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,9 @@ # Docsy -Docsy is a [Hugo](https://gohugo.io/) theme for technical documentation sets, providing simple navigation, site structure, and more. +This repository is based by Docsy a [Hugo](https://gohugo.io/) theme for technical documentation sets, providing simple navigation, site structure, and more. +Docsy was used to hosting the site : https://ciclorifugio.netlify.app/ +CICLORIFUGIO 4.0 was developed by ITS ICT foundation, based in Turin, Italy. -This is not an officially supported Google product. This project is actively being maintained. - -## Prerequisites - -The following are basic prerequisites for using Docsy in your site: - -- Install a recent release of the Hugo "extended" version (we recommend version 0.53 or later). If you install from the - [release page](https://github.com/gohugoio/hugo/releases), make sure you download the `_extended` version - which supports SCSS. - -- Install `PostCSS` so that the site build can create the final CSS assets. You can install it locally by running - the following commands from the root directory of your project: - - ``` - sudo npm install -D --save autoprefixer - sudo npm install -D --save postcss-cli - ``` - -## Example and usage - -You can find an example project that uses Docsy in the [Docsy Example Project repo](https://github.com/google/docsy-example).The Docsy Example Project is hosted at [https://example.docsy.dev/](https://example.docsy.dev/). For real-life examples of sites that use Docsy (and their source repos), see our [Examples](https://www.docsy.dev/docs/examples/) page. - -To use the Docsy theme for your own site: - - - (Recommended) Use the [example project](https://github.com/google/docsy-example), - which includes the Docsy theme as a submodule, as a template to create your project. - You can customize this pre-configured basic site into your own Docsy themed site. - [Learn more...](https://github.com/google/docsy-example) - - - Add Docsy to your existing Hugo site repo's `themes` directory. You can either add Docsy as a Git submodule, or - clone the Docsy theme into your project. - -See the [Docsy Getting Started Guide](https://docsy.dev/docs/getting-started/) for -details about the various usage options. - -## Documentation - -Docsy has its own user guide (using Docsy, of course!) with lots more information about using the theme, which you can find at [https://docsy.dev/](https://docsy.dev/). Alternatively you can use Hugo to generate and serve a local copy of the guide (also useful for testing local theme changes), making sure you have installed all the prerequisites listed above: - -``` -git clone --recurse-submodules --depth 1 https://github.com/google/docsy.git -cd docsy/userguide/ -hugo server --themesDir ../.. -``` - -Note: you need the `themesDir` flag when running Hugo because the site files are inside the theme repo. ## Contributing ![GitHub](https://img.shields.io/github/contributors/google/docsy) From 9ab6c3cb378fbcfef7196253dc8f58dff2bd44fd Mon Sep 17 00:00:00 2001 From: attuccigiulio <84907550+attuccigiulio@users.noreply.github.com> Date: Tue, 6 Jul 2021 17:41:43 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cdd6cfc581..7ebb062e7a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Docsy +# CICLORIFUGIO 4.0 This repository is based by Docsy a [Hugo](https://gohugo.io/) theme for technical documentation sets, providing simple navigation, site structure, and more. Docsy was used to hosting the site : https://ciclorifugio.netlify.app/ From 37d5d4a080b2e26c1c0b9f3050bde28c2fb74bf2 Mon Sep 17 00:00:00 2001 From: attuccigiulio <84907550+attuccigiulio@users.noreply.github.com> Date: Tue, 6 Jul 2021 18:13:16 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index 7ebb062e7a..87fb424388 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,42 @@ Docsy was used to hosting the site : https://ciclorifugio.netlify.app/ CICLORIFUGIO 4.0 was developed by ITS ICT foundation, based in Turin, Italy. +## Contributing ![GitHub](https://img.shields.io/github/contributors/google/docsy) + +Please read [CONTRIBUTING.md](https://github.com/google/docsy/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. +See also the list of [contributors](https://github.com/google/docsy/graphs/contributors) who participated in this project. + +## License ![GitHub](https://img.shields.io/github/license/google/docsy) + +This project is licensed under the Apache License 2.0 - see the [LICENSE.md](https://github.com/google/docsy/blob/master/LICENSE) file for details. + +You can find an example project that uses Docsy in the [Docsy Example Project repo](https://github.com/google/docsy-example).The Docsy Example Project is hosted at [https://example.docsy.dev/](https://example.docsy.dev/). For real-life examples of sites that use Docsy (and their source repos), see our [Examples](https://www.docsy.dev/docs/examples/) page. + +To use the Docsy theme for your own site: + + - (Recommended) Use the [example project](https://github.com/google/docsy-example), + which includes the Docsy theme as a submodule, as a template to create your project. + You can customize this pre-configured basic site into your own Docsy themed site. + [Learn more...](https://github.com/google/docsy-example) + + - Add Docsy to your existing Hugo site repo's `themes` directory. You can either add Docsy as a Git submodule, or + clone the Docsy theme into your project. + +See the [Docsy Getting Started Guide](https://docsy.dev/docs/getting-started/) for +details about the various usage options. + +## Documentation + +Docsy has its own user guide (using Docsy, of course!) with lots more information about using the theme, which you can find at [https://docsy.dev/](https://docsy.dev/). Alternatively you can use Hugo to generate and serve a local copy of the guide (also useful for testing local theme changes), making sure you have installed all the prerequisites listed above: + +``` +git clone --recurse-submodules --depth 1 https://github.com/google/docsy.git +cd docsy/userguide/ +hugo server --themesDir ../.. +``` + +Note: you need the `themesDir` flag when running Hugo because the site files are inside the theme repo. + ## Contributing ![GitHub](https://img.shields.io/github/contributors/google/docsy) Please read [CONTRIBUTING.md](https://github.com/google/docsy/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. @@ -13,3 +49,4 @@ See also the list of [contributors](https://github.com/google/docsy/graphs/contr ## License ![GitHub](https://img.shields.io/github/license/google/docsy) This project is licensed under the Apache License 2.0 - see the [LICENSE.md](https://github.com/google/docsy/blob/master/LICENSE) file for details +