Отображение содержимого файла README.md на моем сайте
Я хочу отобразить содержимое файла README.md в GitHub из моего репозитория на моем сайте. Я относительно новичок в программировании, поэтому я немного запутался. Насколько я могу судить: мне нужно ввести URL моего репозитория, который отображает файл readme.md на первой странице. затем получить доступ к информации файла в формате markdown и скопировать ее (и, возможно, перевести) на мою HTML-страницу
я использую Django, если это имеет какое-то значение
Вы используете API GitHub для доступа к файлам репозитория, а затем отображаете содержимое файла README.md
в HTML с помощью элемента, сохраняющего перенос строк. Запрос API по умолчанию будет направлен на ветку хранилища по умолчанию (обычно main
). Вот как это можно сделать.
function getReadme(user, repo) {
fetch(`https://api.github.com/repos/${user}/${repo}/contents/README.md`) // Fetch the file from GitHub's api
.then(response => response.json())
.then(data => {
const content = atob(data.content); // Convert from base64 to readable text
document.getElementById("readme-text").textContent = content; // Apply content to the document
console.log(content); // Log the content to the console
})
.catch(error => console.log(error)); // Catch any errors
}
getReadme("facebook", "react");
<h1>My README</h1>
<pre id="readme-text"></pre> <!-- "<pre>" preserves line breaks -->