How to use readme file as main site page instead of index?

[SusanAVanD]

This is just a result of me not knowing what I'm doing. I couldn't get the github.io page to work unless I used the index.html file and I don't know how to fix that.

[chrisdaaz]

Hi @SusanAVanD,

You're on the right track! Your repository just needs an index.md file, rather than an index.html file. Create an index.md file in your project root, and put this Markdown content in the file (see an example from the Jekyll Slate theme repository:

---
layout: default
---

# Dickinson Scholar Metadata Application Profile

### Site Link

[https://susanavand.github.io](https://susanavand.github.io/)

### Overview

**Last updated: March 2024**

This profile describes metadata elements for item-level asset records
created and managed by [Dickinson College](https://www.dickinson.edu)
for its institutional repository, [Dickinson
Scholar](https://dickinson.hykucommons.org/). The purpose of
establishing this profile is to document current metadata standards and
cataloging procedures.

### Contents

This site includes a quick look at each element and obligation. This
information appears in more detail on the Elements page, sorted by
obligation and element name. We also provide a representative sample of
authority sources which contribute to our custom metadata profile.

-   A
    [Quicklook](https://github.com/SusanAVanD/SusanAVanD.github.io/blob/master/quicklook.md)
    summary table with element names and obligations.
-   Details about [Dickinson Scholar metadata
    elements](https://github.com/SusanAVanD/SusanAVanD.github.io/blob/master/elements.md).
-   Overview of [controlled vocabularies, schemas, and
    formatting](https://github.com/SusanAVanD/SusanAVanD.github.io/blob/master/controlledvocabs.md)
    applied to portions of the input values for select elements.

### Acknowledgements

Repository forked from [Carnegie Hall Digital Collections Metadata
Application
profile](https://github.com/CarnegieHall/digitalcolls-metadataprofile)

### License

MIT License - see
[License](https://github.com/SusanAVanD/SusanAVanD.github.io/blob/master/LICENSE.md)
for details.