Skip to content

Commit

Permalink
docs: oppdater readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
adalinesimonian committed Mar 12, 2024
1 parent 7af4c98 commit d422097
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 43 deletions.
68 changes: 25 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,36 @@
# Hugo template for Decap CMS with Netlify Identity
# NLL Website

This is a small business template built with [Hugo](https://gohugo.io) and [Decap CMS](https://github.com/decaporg/decap-cms), designed and developed by [Darin Dimitroff](https://twitter.com/deezel), [spacefarm.digital](https://www.spacefarm.digital).
<img src="site/static/nll-logo.png" alt="NLL Logo" width="100px" align="left"> Norwegian Language Learning (NLL) is a community of people who support each other in learning and helping others learn the Norwegian language. We operate a [Discord server](https://discord.gg/mBsKjx7) that welcomes everyone, whether Norwegian is their native language or they are just beginning their language learning journey.

## Getting started
This repository contains the source code that powers the NLL website.

Use our deploy button to get your own copy of the repository.
## Contributing

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/decaporg/one-click-hugo-cms&stack=cms)
> [!IMPORTANT]
> If you are not familiar with Git, GitHub, or the command line, you can still contribute to the website. You can contribute using the Decap CMS (formerly Netlify CMS) interface at [https://nllcommunity.github.io/admin](https://nllcommunity.github.io/admin).
>
> If your primary purpose is to contribute content, you do not need to follow the instructions in this section. You can simply use the Decap CMS interface to contribute content.
This will setup everything needed for running the CMS:
Make sure you have [Node.js](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/) installed.

* A new repository in your GitHub account with the code
* Full Continuous Deployment to Netlify's global CDN network
* Control users and access with Netlify Identity
* Manage content with Decap CMS
> [!TIP]
> It is recommended to use [Volta](https://volta.sh/) to manage Node.js versions. If Volta is installed, you do not need to do anything. When you run any commands in this repository, Volta will automatically install and install the correct versions of both Node.js and Yarn.
Once the initial build finishes, you can invite yourself as a user. Go to the Identity tab in your new site, click "Invite" and send yourself an invite.
1. Clone the repository
2. Run `yarn` to install dependencies
3. Run `yarn start` to start the development server
4. Open [http://localhost:3120](http://localhost:3120) in your browser
5. Make changes to the code and see the changes live in your browser
6. Commit your changes and [open a pull request](https://github.com/nllcommunity/nllcommunity.github.io/pulls)

Now you're all set, and you can start editing content!
```sh
git clone https://github.com/nllcommunity/nllcommunity.github.io.git
cd nllcommunity.github.io

## Local Development

Clone this repository, and run `yarn` or `npm install` from the new folder to install all required dependencies.

Then start the development server with `yarn start` or `npm start`.

## Testing

With the development server running, run the tests locally
with `yarn cypress:run` or `npm run cypress:run`.
Or use `yarn cypress:open` or `npm run cypress:open` to run interactively.

Cypress tests also run on deploy with the [Cypress Netlify integration](https://www.netlify.com/integrations/cypress/).

## Layouts

The template is based on small, content-agnostic partials that can be mixed and matched. The pre-built pages showcase just a few of the possible combinations. Refer to the `site/layouts/partials` folder for all available partials.

Use Hugo’s `dict` functionality to feed content into partials and avoid repeating yourself and creating discrepancies.

## CSS

The template uses a custom fork of Tachyons and PostCSS with cssnext and cssnano. To customize the template for your brand, refer to `src/css/imports/_variables.css` where most of the important global variables like colors and spacing are stored.

## SVG Social Icons
yarn
yarn start
```

The social media icons are in `site/assets/img`.
Make sure you use consistent icons in terms of viewport and art direction for optimal results.
For an icon named `icons-facebook.svg`, refer to the SVG `social-icon` partial like so:
## Licence

```
{{ partial "social-icon" (dict "link" "#" "svg" "icons-facebook" "alt" "Kaldi on Facebook") }}
```
This project is licensed under the [MIT License](LICENSE).
Binary file added site/static/nll-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d422097

Please sign in to comment.