Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
158 lines (101 sloc) 8.54 KB

+++ title = "Getting started"

date = 2016-04-20 toc = true # Show table of contents? true/false type = "docs" # Do not modify. weight = 20

math = true

aliases = ["post/getting-started/"]

[menu.docs] parent = "setup" weight = 20 +++

This quick tutorial will show you how to setup and use Academic.

Choose the right theme for you

Check out the [available color themes]({{< relref "../themes.md" >}}) and have fun choosing a design you love.

Once you have settled on a theme, edit your config/_default/params.toml file in a text editor and set the color_theme option to the name of the chosen theme.

{{% alert note %}} If you are unfamiliar with setting options in a TOML file, you can [learn more about this human-friendly configuration syntax here]({{< relref "./front-matter.md" >}}). {{% /alert %}}

{{% alert warning %}} In older versions, the configuration is stored entirely in one file named config.toml. {{% /alert %}}

The following font styles are also available and can be set by the font option:

  • default (modern)
  • classic (original Academic v1 style)
  • playfair (traditional serif)

Don't worry if you are not 100% happy with the colors or font yet, as these can be fully customized [later on]({{< relref "customization.md" >}}).

Choose the right layout for you

Academic has a template for you whether you are you creating a website for your CV, academic research, blog, course, lab, business, photography, portfolio, or restaurant!

What kind of content would you like to publish? Academic supports:

  • Pages: any general content
  • Widget Pages: pages that can consist of numerous widgets, such as the homepage
  • Posts: blog posts or news
  • Projects: publish your portfolio or projects
  • Online Courses: share knowledge online
  • Software Documentation: document your software projects
  • Talks: publish any talks which you are presenting
  • Slides: write slides very efficiently with Markdown, present them at your talk, and share them online
  • Publications: import your research publications from BibTeX

Once you have decided on the type of content that you would like to publish, take a look at the [available homepage widgets]({{< relref "page-builder.md" >}}) and consider which ones would be most relevant to you.

Then, open your content/home/ folder and set the active parameter to either true or false for each widget depending on if you wish to display it or not. Widgets that you don't need can alternatively be deleted rather than setting active to false.

Next, let's position the widgets according to your preference. To move a widget up or down, increase or decrease the value of the weight parameter in each widget which you activated. The widgets will be ordered in ascending order of these weights and there is no need for the weights to be consecutive numbers.

{{% alert note %}} If your content/home/ folder is empty, populate it from the [example]({{< relref "install.md#demo-content" >}}). {{% /alert %}}

Customize it

After selecting a theme and a layout, make it your own.

Core parameters

The core parameters for the website can be edited in the config/_default/params.toml file:

  • Edit your personal/business details under the Contact Widget section
    • Any details entered here will be displayed in the Contact widget (if used)
    • To hide a contact field, simply clear the value to "" or comment the line out by prefixing it with a hash (#)
    • The [contact form can be configured]({{< relref "page-builder.md#contact" >}}) separately in the front matter of the Contact widget itself
  • If you write technical content, consider setting highlight = true and/or math = true, otherwise set them to false
    • If you write R code, uncomment highlight_languages (remove the # line prefix) so that highlight_languages = ["r"]

Introduce yourself

By default, a superuser is created with the username admin and corresponding user profile located at content/authors/admin/_index.md. Let's open this file in a text editor and edit this file to make it your profile:

  • Edit your display name (typically your full name), your role, and write one sentence to describe yourself in bio
  • Edit the organizations that you are affiliated with, or set this to [] to hide it
  • List your interests or hobbies in interests, or set this to [] to hide it
  • List your main qualifications using the education --> courses block
    • These blocks can be created or deleted as required
    • To hide qualifications, delete these blocks or comment out the lines by prefixing them with a hash (#)
  • Add your social or academic networking links
    • These are defined as instances of social and can be created or deleted as required

Now let's add a biography or some fun facts about you after the front matter (i.e. after the last --- line). You can utilize [Markdown and shortcodes for formatting]({{< relref "./writing-markdown-latex.md" >}}).

To display an avatar, place a square cropped portrait photo named avatar into your profile folder at content/authors/admin/, overwriting the example image. Alternatively, if you have an existing Gravatar/Wordpress avatar, you can use it by setting gravatar to true in config/_default/params.toml and entering your associated email address in content/authors/admin/_index.md. Note that you can delete the example avatar image to disable the avatar feature.

Once you have setup your account, your username can be referenced in the authors field of content, as per the demo post.

{{% alert note %}} The superuser username can be changed from admin by renaming the admin folder. Usernames must be lowercase with any spaces replaced with hyphens (-). The ASCII alphanumeric character set is recommended. {{% /alert %}}

{{% alert warning %}} If you change a username, you may wish to update any references to it from the author field of the About widget (content/home/about.md) and the authors field in the front matter of your content. {{% /alert %}}

Menu

The navigation menu can be edited in the config/_default/menu.toml file:

The [[main]] entries define the navigation links at the top of the website. They can be added or removed as desired, based on the layout which you chose above.

To link to a section of the homepage, use the form #<section-filename> where <section-filename> is the filename (without .md extension). For example, #posts references a section with filename posts.md. You can rename your section files in content/home/, just remember to use a dash (-) instead of spaces in the filename.

{{% alert note %}} To create a dropdown sub-menu, add identifier: "something" to the parent item and parent: "something" to the child item. {{% /alert %}}

Read more about Hugo's menu system here.

Add your content

Refer to our guide on [managing content]({{< relref "managing-content.md" >}}) to create your own content such as blog posts, publications, talks, and projects.

Remove any unused example pages

[Delete any unused example pages]({{< relref "managing-content.md#removing-content" >}}).

{{% alert note %}} You will likely want to keep the _index.md files (notice the underscore prefix) as they configure the archive page for each content type (e.g. an index of all your blog posts). {{% /alert %}}

View your site

If you installed on your computer with Git or ZIP, view your new website by running the hugo server command.

If you installed using RStudio, run blogdown::serve_site() to preview your site in your web browser. We recommend previewing your site in your normal web browser as the in-built RStudio web browser is very outdated and buggy.

Now visit localhost:1313 and your new Academic powered website will appear. Otherwise, if using Netlify, they will provide you with your URL.

Deploy your site

Before deploying your site, there are some final options we can set in config/_default/config.toml:

  • Set title to your desired website title, such as your name or business name
  • Set baseurl to your website URL (this will be provided by your host such as [Netlify]({{< relref "deployment.md" >}})) - come back to this option later if you don't have your URL/domain yet

Publish your site to the world by following the [deployment steps]({{< relref "deployment.md" >}}).

Support Academic

Has Academic helped you?

Academic is a free open source platform. [Please kindly consider supporting further development.]({{< relref "/#support" >}})

You can’t perform that action at this time.