Skip to content

Commit d422097

Browse files
docs: oppdater readme.md
1 parent 7af4c98 commit d422097

File tree

2 files changed

+25
-43
lines changed

2 files changed

+25
-43
lines changed

README.md

+25-43
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,36 @@
1-
# Hugo template for Decap CMS with Netlify Identity
1+
# NLL Website
22

3-
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).
3+
<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.
44

5-
## Getting started
5+
This repository contains the source code that powers the NLL website.
66

7-
Use our deploy button to get your own copy of the repository.
7+
## Contributing
88

9-
[![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)
9+
> [!IMPORTANT]
10+
> 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).
11+
>
12+
> 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.
1013
11-
This will setup everything needed for running the CMS:
14+
Make sure you have [Node.js](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/) installed.
1215

13-
* A new repository in your GitHub account with the code
14-
* Full Continuous Deployment to Netlify's global CDN network
15-
* Control users and access with Netlify Identity
16-
* Manage content with Decap CMS
16+
> [!TIP]
17+
> 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.
1718
18-
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.
19+
1. Clone the repository
20+
2. Run `yarn` to install dependencies
21+
3. Run `yarn start` to start the development server
22+
4. Open [http://localhost:3120](http://localhost:3120) in your browser
23+
5. Make changes to the code and see the changes live in your browser
24+
6. Commit your changes and [open a pull request](https://github.com/nllcommunity/nllcommunity.github.io/pulls)
1925

20-
Now you're all set, and you can start editing content!
26+
```sh
27+
git clone https://github.com/nllcommunity/nllcommunity.github.io.git
28+
cd nllcommunity.github.io
2129

22-
## Local Development
23-
24-
Clone this repository, and run `yarn` or `npm install` from the new folder to install all required dependencies.
25-
26-
Then start the development server with `yarn start` or `npm start`.
27-
28-
## Testing
29-
30-
With the development server running, run the tests locally
31-
with `yarn cypress:run` or `npm run cypress:run`.
32-
Or use `yarn cypress:open` or `npm run cypress:open` to run interactively.
33-
34-
Cypress tests also run on deploy with the [Cypress Netlify integration](https://www.netlify.com/integrations/cypress/).
35-
36-
## Layouts
37-
38-
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.
39-
40-
Use Hugo’s `dict` functionality to feed content into partials and avoid repeating yourself and creating discrepancies.
41-
42-
## CSS
43-
44-
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.
45-
46-
## SVG Social Icons
30+
yarn
31+
yarn start
32+
```
4733

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

52-
```
53-
{{ partial "social-icon" (dict "link" "#" "svg" "icons-facebook" "alt" "Kaldi on Facebook") }}
54-
```
36+
This project is licensed under the [MIT License](LICENSE).

site/static/nll-logo.png

4.58 KB
Loading

0 commit comments

Comments
 (0)