Create a site with Github/Gitlab
Create your site
After choosing a template above, you’ll be greeted with the welcome screen below.
Click the big Connect To Github button on the welcome screen (or alternatively click the link underneath to connect with Gitlab):
Login with your Github account (or create a new Github account):
Click Save & Deploy to create a repository for your site in Github:
Netlify will now generate your new site. Generally this takes around 1 to 5 minutes, but can take longer during busy periods. You’ll see the green “Published” notice appear under Production Deploys once it has completed.
Error scheduling buildin which case, wait a minute and then click Retry Deploy > Deploy Site to retry.
The random URL assigned to us by Netlify is quite irrelevant. Let’s customize the URL to something more relevant to our site…
Click Edit site name…
Enter your name, separating your first and last name with a hyphen (
-) rather than a space.
Alternatively, enter an organisation name if you’re creating a site for an organisation.
Some creativity may be required to find a subdomain that is freely available. Don’t worry about finding the perfect subdomain as later, we’ll register our own custom domain name and connect it with our site.
Lastly, click Save to update our Netlify subdomain.
Awesome! We can now visit the site at the URL you chose!
Depending on the template we chose, we’ll see something similar to the Academic Starter Demo, but without the demo content.
Now, let’s personalize our shiny new site based on our requirements ⭐ ⭐ ⭐
Personalize your site
Login to GitHub and view the
starter-... repository which you created in the steps above:
Let’s click through to the
Following this guide, we can click a file within the
config/_default/ folder, click the pencil icon in the top right to edit the settings, and scroll to the bottom of the page to click the green
Commit changes button to save the file. Optionally, when saving the file, we can add a message for our records, to describe the change.
First, let’s edit
config.toml to update our site with a title (such as your name or organisation) and the URL assigned to us by Netlify:
Click the green
Commit changes button to save the
Next, let’s edit
params.toml to choose a theme and decide which features we’d like to use on our site. The Getting Started guide walks us through the main options to personalize our site.
Click the green
Commit changes button to save the
A few minutes after saving (i.e. committing a file), your site will automatically update.
Next, let’s setup the admin panel and use it to edit our author profile and begin adding content to our site!
Write content online
To easily edit your site in a rich online editor in your browser,
1. Enable the CMS integration
For the Academic template, you can skip this step as the module is enabled by default.
For other templates, browse your GitHub project to check that the CMS module is added to your
# At the bottom of your `config.toml` is a Module section: [module] # Your existing modules will appear here. # Add the CMS module below, if it has not already been added: [[module.imports]] path = "github.com/wowchemy/wowchemy-hugo-modules/netlify-cms-academic"
and that the Netlify CMS integration is enabled in your
[cms] netlify_cms = true
2. Enable Netlify Identity
- Login to Netlify and click the site you deployed with Netlify
- Go to Settings > Identity, and select Enable Identity service
- Under Registration preferences, select Invite Only
- Scroll down to Services > Git Gateway, and click Enable Git Gateway
- This allows editors to write content without needing a GitHub account
3. Invite editors
Head to the Identity tab at the top of the Netlify dashboard and then click the Invite Users button.
Invite yourself and any collaborators to become editors.
4. Login to the editor
Head over to
YOUR_SITE.netlify.app/admin/ to view your content management panel and begin publishing content, replacing
YOUR_SITE with the subdomain assigned to you earlier in this guide (or your custom URL, in the form
Note that the preview window in the online editor is limited to rendering basic Markdown and doesn’t accurately represent how your site will be rendered. However, it can be useful for getting started or writing on the go.
For the full experience of seeing exactly what you are editing, check out the next section to edit on your computer.
static/admin/(if exists), remove the
config/_default/config.toml(if exists), and set
netlify_cms = falseunder the
Personalize your homepage
View the Homepage Builder guide to learn how to add widgets to the homepage or other widget pages.
Navigate to the
content/home/ folder in Github to edit your homepage widgets or to create/remove widgets.
Edit content on your computer
You can also edit your site on your computer with the beautifully simple Typora editor (which supports math and diagrams).